List Payouts
Retrieve a list of payouts that you created.
The list can include up to 1000 payouts. You can filter the list with query parameters.
beneficiary
Filters according to the beneficiary ID. String starting with beneficiary_.
created_after
The ID of the payout created before the first payout you want to retrieve. String starting with payout_.
created_before
The ID of the payout created after the last payout you want to retrieve. String starting with payout_.
ending_before
The ID of a payout in the list. The list ends with the payout that was created before the payout with this ID. Use this filter to get the previous page of results. String starting with payout_. Deprecated.
ewallet
Filters according to the wallet ID. String starting with ewallet_.
invoice
Filters according to the invoice. String starting with invoice_.
limit
The maximum number of payouts to return. Range: 1-1000. Default is 10.
merchant_reference_id
Filters according to the merchant reference ID.
payout_method_type
Filters according to the type of payout method. The two-letter prefix must match the beneficiary country code.
sender
Filters according to the sender ID. String starting with sender_.
sender_country
Filters according to the country of the sender. Two-letter ISO 3166-1 ALPHA-2 code.
sender_currency
Filters according to the currency that the sender is paying with. Three-letter ISO 4217 code.
starting_after
The ID of a payout in the list. The list begins with the payout that was created next after the payout with this ID. Use this filter to get the next page of results. Relevant when
ending_beforeis not used. String starting with payout_. Deprecated.
subscription
Filters according to the subscription ID. String starting with sub_.
.NET
using System; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { string limit = "2"; string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/payouts?limit={limit}"); Console.WriteLine(result); } catch (Exception e) { Console.WriteLine("Error completing request: " + e.Message); } } } }
JavaScript
const makeRequest = require('<path-to-your-utility-file>/utilities').makeRequest; async function main() { try { const result = await makeRequest('GET', '/v1/payouts?limit=2'); console.log(result); } catch (error) { console.error('Error completing request', error); } }
PHP
<?php $path = $_SERVER['DOCUMENT_ROOT']; $path .= "/<path-to-your-utility-file>/utilities.php"; include($path); try { $object = make_request('get', '/v1/payouts?limit=2'); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?>
Python
from pprint import pprint from utilities import make_request results = make_request(method='get', path=f'/v1/payouts?limit=2') pprint(results)
/v1/payouts
List Payouts with Limit
curl -X get https://sandboxapi.rapyd.net/v1/payouts?limit=2 -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "5f98c1d8-1194-4203-aa66-f90f1d500cec" }, "data": [ { "id": "payout_51fc84d67db6415f6ef4911790616de8", "payout_type": "bank", "payout_method_type": "us_general_bank", "amount": 110, "payout_currency": "USD", "sender_amount": 110, "sender_currency": "USD", "status": "Error", "sender_country": "US", "sender": null, "beneficiary_country": "US", "beneficiary": null, "fx_rate": 1, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary ." } ] } ], "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 110, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Payout - Bank Transfer: Beneficiary/Sender IDs", "created_at": 1690800499, "payout_fees": null, "expiration": null, "merchant_reference_id": "GHY-0YU-HUJ-POI", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELDS:MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.PAYMENT_TYPE]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null }, { "id": "payout_a821226dc49bf4ce5b79370a248aad30", "payout_type": "bank", "payout_method_type": "us_general_bank", "amount": 110, "payout_currency": "USD", "sender_amount": 110, "sender_currency": "USD", "status": "Error", "sender_country": "US", "sender": null, "beneficiary_country": "US", "beneficiary": null, "fx_rate": 1, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary ." } ] } ], "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 110, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1690800193, "payout_fees": null, "expiration": null, "merchant_reference_id": "GHY-0YU-HUJ-POI", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELDS:MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.PAYMENT_TYPE]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null } ] }
List Payouts - Filtered by Merchant Reference ID
curl -X get https://sandboxapi.rapyd.net/v1/payouts?merchant_reference_id=780-456-67G -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "68d4d129-9bc0-44a8-a4f3-1ff32325cb81" }, "data": [ { "id": "payout_649643f0d0aaacf05b9b2dd14eb6abcf", "payout_type": "bank", "payout_method_type": "us_general_bank", "amount": 110, "payout_currency": "USD", "sender_amount": 110, "sender_currency": "USD", "status": "Created", "sender_country": "US", "sender": { "id": "sender_cb252191c6951695f3cb31cf1746b904", "country": "US", "entity_type": "individual", "address": "123 First Street", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "state": "NY", "account_number": "123456789", "currency": "USD", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "ABCDEFGHI", "beneficiary_relationship": "client", "source_of_income": "salary" }, "beneficiary_country": "US", "beneficiary": { "id": "beneficiary_061672d97f51ed2523db6f458653e11f", "country": "US", "entity_type": "individual", "address": "456 Second Street", "name": "Jane Doe", "postcode": "10101", "city": "Anytown", "state": "NY", "currency": "USD", "email": "janedoe@rapyd.net", "identification_type": "SSC", "identification_value": "123456789", "ach_code": "123456789" }, "fx_rate": 1, "instructions": { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary ." } ] }, "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 110, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1608021001, "payout_fees": null, "expiration": null, "merchant_reference_id": "780-456-67G", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": null } ] }
List Payouts - Filtered by Beneficiary
curl -X get https://sandboxapi.rapyd.net/v1/payouts?beneficiary=beneficiary_061672d97f51ed2523db6f458653e11f -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "cde8dfe1-3b7a-4b67-b6fc-fa4865070d41" }, "data": [ { "id": "payout_649643f0d0aaacf05b9b2dd14eb6abcf", "payout_type": "bank", "payout_method_type": "us_general_bank", "amount": 110, "payout_currency": "USD", "sender_amount": 110, "sender_currency": "USD", "status": "Created", "sender_country": "US", "sender": { "id": "sender_cb252191c6951695f3cb31cf1746b904", "country": "US", "entity_type": "individual", "address": "123 First Street", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "state": "NY", "account_number": "123456789", "currency": "USD", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "ABCDEFGHI", "beneficiary_relationship": "client", "source_of_income": "salary" }, "beneficiary_country": "US", "beneficiary": { "id": "beneficiary_061672d97f51ed2523db6f458653e11f", "country": "US", "entity_type": "individual", "address": "456 Second Street", "name": "Jane Doe", "postcode": "10101", "city": "Anytown", "state": "NY", "currency": "USD", "email": "janedoe@rapyd.net", "identification_type": "SSC", "identification_value": "123456789", "ach_code": "123456789" }, "fx_rate": 1, "instructions": { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary ." } ] }, "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 110, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1608021001, "payout_fees": null, "expiration": null, "merchant_reference_id": "780-456-67G", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": null } ] }
List Payouts - Filtered by Payout Method Type
curl -X get https://sandboxapi.rapyd.net/v1/payouts?payout_method_type=mx_abc_capital_bank -H 'access_key: your-access-key-here' -H 'Content-Type: application/json' -H 'idempotency: your-idempotency-parameter-here' -H 'salt: your-random-string-here' -H 'signature: your-calculated-signature-here' -H 'timestamp: your-unix-timestamp-here'
{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "c1f74ac9-4cf1-45ae-834e-f5f306e01a22" }, "data": [ { "id": "payout_17f93e0eb38d062cd6dc170648074e09", "payout_type": "bank", "payout_method_type": "mx_abc_capital_bank", "amount": 2000, "payout_currency": "MXN", "sender_amount": 102.78, "sender_currency": "USD", "status": "Created", "sender_country": "US", "sender": { "id": "sender_94e84ba869e20da70be5b0c0027c889d", "country": "US", "entity_type": "company", "address": "address 2", "name": "Rapyd", "postcode": "3333", "city": "Amsterdam", "phone_number": "19019044444", "company_name": "Rapyd", "currency": "USD", "identification_value": "unc_num_123333", "province": "Amsterdam", "occupation": "Ridesharing" }, "beneficiary_country": "MX", "beneficiary": { "id": "beneficiary_d75798c2168f04a552542880ba772966", "last_name": "Doe", "first_name": "Jane", "country": "MX", "entity_type": "individual", "name": "Jane Doe", "currency": "MXN", "category": "bank" }, "fx_rate": 0.051389, "instructions": { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary ." } ] }, "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 102.78, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Salary", "created_at": 1606738395, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": null }, { "id": "payout_ca74db210e478dfd61030799c2fc8a8e", "payout_type": "bank", "payout_method_type": "mx_abc_capital_bank", "amount": 2000, "payout_currency": "MXN", "sender_amount": 102.78, "sender_currency": "USD", "status": "Created", "sender_country": "US", "sender": { "id": "sender_94e84ba869e20da70be5b0c0027c889d", "country": "US", "entity_type": "company", "address": "address 2", "name": "Rapyd", "postcode": "3333", "city": "Amsterdam", "phone_number": "19019044444", "company_name": "Rapyd", "currency": "USD", "identification_value": "unc_num_123333", "province": "Amsterdam", "occupation": "Ridesharing" }, "beneficiary_country": "MX", "beneficiary": { "id": "beneficiary_d75798c2168f04a552542880ba772966", "last_name": "Doe", "first_name": "Jane", "country": "MX", "entity_type": "individual", "name": "Jane Doe", "currency": "MXN", "category": "bank" }, "fx_rate": 0.051389, "instructions": { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary ." } ] }, "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 102.78, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Salary", "created_at": 1606738472, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": null }, { "id": "payout_1e53f6bd01b20fff95f8e042b5bc71d3", "payout_type": "bank", "payout_method_type": "mx_abc_capital_bank", "amount": 2000, "payout_currency": "MXN", "sender_amount": 102.41, "sender_currency": "USD", "status": "Created", "sender_country": "US", "sender": { "id": "sender_94e84ba869e20da70be5b0c0027c889d", "country": "US", "entity_type": "company", "address": "address 2", "name": "Rapyd", "postcode": "3333", "city": "Amsterdam", "phone_number": "19019044444", "company_name": "Rapyd", "currency": "USD", "identification_value": "unc_num_123333", "province": "Amsterdam", "occupation": "Ridesharing" }, "beneficiary_country": "MX", "beneficiary": { "id": "beneficiary_d75798c2168f04a552542880ba772966", "last_name": "Doe", "first_name": "Jane", "country": "MX", "entity_type": "individual", "name": "Jane Doe", "currency": "MXN", "category": "bank" }, "fx_rate": 19.530029, "instructions": { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary ." } ] }, "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 102.41, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Salary", "created_at": 1607872509, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": null } ] }