--- title: "List Payouts" source_url: https://docs.rapyd.net/en/list-payouts.html lang: en --- # 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. > **Note:** > > - The code samples include successful requests (200) and bad requests (400). > > - For error messages that appear due to bad requests (400), see: > > - [General Errors](https://docs.rapyd.net/en/general-errors.md "General Errors") > - [Payout Errors](https://docs.rapyd.net/en/payout-errors.md "Payout Errors") > - For information about unauthorized request (401) and other authentication errors, see [Troubleshooting Authentication and Authorization Errors](https://docs.rapyd.net/en/troubleshooting-authentication-and-authorization-errors.md "Troubleshooting Authentication and Authorization Errors"). ### Parameters ### Request Query Parameters - - batch_token - Filters according to the ID of a mass payout file. String starting with **batch_**. - - 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-100. 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_before` is not used. String starting with **payout_**. Deprecated. - - subscription - Filters according to the subscription ID. String starting with **sub_**. ### Request Header Parameters - - access_key - Unique access key provided by Rapyd for each authorized user. See [Developers](https://docs.rapyd.net/en/developers.md "Developers"). - - Content-Type - Indicates that the data appears in JSON format. Set to **application/json**. - - salt - Random string. Recommended length: 8-16 characters. - - signature - Signature calculated for each request individually. See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures"). - - timestamp - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds). ### Response Parameters - - amount - Amount of the payout, in units defined by `payout_currency`. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015. Same as `payout_amount`. - - batch_file - Batch file ID. Relevant to batch payouts that were created via the Client Portal. - - beneficiary - Object describing the beneficiary. - - beneficiary_country - Beneficiary bank country. The country to which funds are sent. Two-letter ISO 3166-1 ALPHA-2 code. - - bin_details - Bank identification details. Relevant to cards. - - bin_number - [Bank identification number](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_bin "Bank Identification Number") of the issuing bank. - - brand - The brand of the card. - - country - The country where the card was issued. - - issuer - Name of the bank that issued the card. - - level - The level of the card. - - type - The type of card. - - created_at - Time of creation of the `payout` object, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - crypto_payout_hash - A unique identifier that is proof that a payout was validated and added to the blockchain. Relevant to stablecoin cryptocurrency payouts via the `xx_stablecoin_ewallet` payout method. Value is **null** when payout has not been completed or when not relevant. - - error - Indicates the error code of the last unsuccessful operation on the `payout` object. - - estimated_time_of_arrival - The estimated time period in which the beneficiary will receive the funds. > **Note:** > > Rapyd will try to complete the payout within the estimated time. However, completion of a payout can be delayed for legal or other reasons. - - ewallets - An array of one object, which contains the following fields: - - ewallet_id - The ID of the wallet that the money is transferred from, a string starting with **ewallet_**. - - amount - Amount of the transaction in currency units defined in `currency`. - - percent - A decimal number representing a percentage of the total payout. - - expiration - Determines the day the payout expires, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). The payout must be completed before the start of this day. Relevant to cash payout methods where the `is_expirable` field is **true** in the response to [List Payout Method Types](https://docs.rapyd.net/en/list-payout-method-types.md "List Payout Method Types"). - - fx_rate - Currency conversion rate for the payout. Decimal. - - gc_error_code - Reserved. - - id - ID of the payout. String starting with **payout_**. - - identifier_type - Reserved. - - identifier_value - Reserved. - - instructions - Describes how the customer collects the payout. Contains the following fields: - - name - Description of the payment method. - - steps - An array containing a list of steps for the customer to take. Each step is named **step*N***, where ***N*** is an integer. - - merchant_ewallet - ID of the client wallet of the sub-merchant. - - merchant_reference_id - Identifier defined by the client for reference purposes. Limit: 45 characters. - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - paid_amount - Cumulative amount received by the beneficiary, in units defined by `payout_currency`. - - paid_at - Time of the payout, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - payout_currency - Currency received by the beneficiary. Three-letter ISO 4217 code. > **Note:** > > Four-letter codes are supported for stablecoin payouts. - - payout_fees - Object that defines transaction fees and foreign exchange fees that the client can define for payout transactions. - - transaction_fee - Describes the fee for processing the transaction. - - calc_type - Specifies how the fee is calculated. One of the following: - **net** - The fee is deducted from the amount paid. For example, in a payment of $100 with a fee of 5%, the recipient receives $95.00 and the $5.00 fee goes to the client wallet. - **gross** - The fee is added to the amount paid. For example, for a transaction of $100 with a fee of 5%, the sender pays $105.00. - - fee_type - One of the following: - **percentage** - A percentage of the transaction amount. For example, 5 percent is represented by **value=5**. - **absolute** - A fixed amount. - - value - The amount of the fee. - - fx_fee - Describes the fees for processing the currency exchange. Relevant to payments with FX. - - calc_type - Specifies how the fee is calculated. One of the following: - **net** - The fee is deducted from the amount paid. For example, in a payment of $100 with a fee of 5%, the recipient receives $95.00 and the $5.00 fee goes to the client wallet. - **gross** - The fee is added to the amount paid. For example, for a transaction of $100 with a fee of 5%, the sender pays $105.00. - - value - The amount of the fee. Percentage. - - fee_currency - The currency in which fees are deducted. Required when  `payout_currency` is stablecoin and `calc_type` is not **gross**. After the fees are calculated, they are converted to the `fee_currency`. One of the following: - **USD** - **EUR** - **GBP** - **SGD** - **HKD** - **AUD** - - gross_fees - The total gross fees for the transaction, in units defined by `currency_code`. - - net_fees - The total net fees for the transaction, in units defined by `merchant_requested_currency`. - - total_merchant_fees - The amount of the fee. - - payout_method_type - The type of payout method. The two-letter prefix must match the country code of the beneficiary. - - payout_type - The type of the payout method. One of the following values: - **bank** - Payout to bank account. - **card** - Payout to card. - **cash** - Payout to cash. - **ewallet** - Payout to local eWallet. - - sender - Object describing the sender. - - company_name - Name of the sender company. Relevant when `entity_type` is **company**. - - country - Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code. - - currency - Currency that the sender is paying with. Three-letter ISO 4217 code. - - entity_type - Type of entity. One of the following values: - **company** - **individual** - - first_name - First name of the sender. Relevant when `entity_type` is **individual**. - - identification_type - Type of identification document for the sender. When `entity_type` is **company**, this field must be **company_registered_number**. When `entity_type` is **individual**, one of the following values: - **drivers_license** - **identification_id** - **international_passport** - **residence_permit** - **social_security** - **work_permit** - - identification_value - Identification number on the document mentioned in `identification_type`. - - last_name - Last name of the sender. Relevant when `entity_type` is **individual**. - - sender_amount - Amount that the sender is paying in units of the currency defined in `sender_currency`. This amount remains the same regardless of FX fees. Decimal. - - sender_country - Country of the sender. Two-letter ISO 3166-1 ALPHA-2 code. - - sender_currency - Currency that the sender is paying with. Three-letter ISO 4217 code. - - statement_descriptor - A statement that includes the reason for the payout. Limited to 35 characters. - - status - Indicates the status of the payout. One of the following: - **Canceled** - The payout was canceled. - **Completed** - The beneficiary received some or all payout funds. - **Confirmation** - The payout is waiting for the beneficiary to confirm the FX rate. - **Created** - The payout was created successfully. - **Declined** - The payout failed to pass inspection. - **Error** - The payout was not created or failed after creation. - **Expired** - The payout has expired. - **Hold** - A bank payout is being reviewed manually by Rapyd Protect. A [Quarantine Under Review Webhook](https://docs.rapyd.net/en/quarantine-under-review-webhook.md "Quarantine Under Review Webhook") is also triggered. - **Pending** - The payout is waiting for the beneficiary to confirm acceptance of the funds. - **Returned** - Funds were returned to after the payout was completed. - - uetr - Unique End-to-End Transaction Reference. A 36-character alphanumeric code that uniquely identifies a specific international payout. When not relevant, the parameter does not appear in the response. - - .NET - ```csharp 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 - ```javascript const makeRequest = require('/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 /utilities.php"; include($path); try { $object = make_request('get', '/v1/payouts?limit=2'); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?> ``` - - Python - ```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 - ```curl 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' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "0f352d10-8dfd-40ed-b412-fc68cb50adca" }, "data": [ { "id": "payout_f2a413634e3d60ce17f27010d77054a1", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 110, "payout_currency": "EUR", "sender_amount": 110, "sender_currency": "EUR", "status": "Completed", "sender_country": "DK", "sender": { "id": "sender_3e92c5047e1f92e7a19e991d15a439a7", "first_name": "John Doe", "country": "DK", "entity_type": "individual", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_861005e8403f3e91b7a270eeb5f75ece", "first_name": "Jane", "country": "AT", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "phone_number": "436641234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "iban": "AT611904300234573201" }, "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": {}, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1762784444, "payout_fees": null, "expiration": null, "merchant_reference_id": "2025-11-10B", "paid_at": "1762784490", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 110, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "81026191-67ea-44f6-8eed-838a5e3c4a12", "crypto_payout_hash": null }, { "id": "payout_d827bdb2750603fcdb76b12f9ab1bfc1", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 38000, "payout_currency": "SGD", "sender_amount": 29108.09, "sender_currency": "USD", "status": "Completed", "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": "SG", "beneficiary": { "id": "beneficiary_81fdb04df9cc01c0488dcbbf02c76edd", "last_name": "Doe", "first_name": "Jane", "country": "US", "entity_type": "individual", "address": "456 Second Street", "name": "Jane Doe", "postcode": "10101", "city": "Anytown", "state": "NY", "account_number": "BG96611020345678", "currency": "SGD", "email": "janedoe@rapyd.net", "identification_type": "SSC", "identification_value": "*********", "bank_name": "sg_ocbc_bank", "bic_swift": "ABCDSGGG", "ach_code": "123456789" }, "fx_rate": 1.3054788068, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_6bf0e86b4c5e451691cf1f4e88b52eec", "amount": 29108.09, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Salary", "created_at": 1762784253, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1762784276", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 38000, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "uetr": "76726191-67ea-44f6-8eed-838a5e3c46yt", "crypto_payout_hash": null } ] } ``` - List Payouts - Filtered by Merchant Reference ID - ```curl 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 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "039be579-e250-4af8-b987-fe8e0f2e71fd" }, "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", "account_number": "BG96611020345678", "currency": "USD", "email": "janedoe@rapyd.net", "identification_type": "SSC", "identification_value": "*********", "bank_name": "US General Bank", "bic_swift": "BUINBGSF", "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, "gc_error_code": null, "batch_file": null, "uetr": "wee26191-67ea-44f6-8eed-838a5e3c4090", "crypto_payout_hash": null } ] } ``` - List Payouts - Filtered by Beneficiary - ```curl 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 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "dc0c6b70-1eb5-4f26-9044-4a3c3087523a" }, "data": [ { "id": "payout_53f4bb989121ebae9e7e8b3746bbccfe", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Completed", "sender_country": "DK", "sender": { "id": "sender_a64bb8e2f970181c5d40aff5ed3de93a", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "name": "Four Star Services", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "company_name": "Four Star Services", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_0bada697cbe155ee969e73691f53a83e", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773795, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1762785144", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 250.25, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "34526191-67ea-44f6-8eed-838a5e3c4543", "crypto_payout_hash": null }, { "id": "payout_42f2009733fca7f4a82a81893d731e91", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_abc7d5eae1cfe9aa1f5d677d3f4ff662", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_0bada697cbe155ee969e73691f53a83e", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773759, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [PAYER.COMPANY_NAME]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "34526191-67ea-44f6-8eed-838a5e3c4tht", "crypto_payout_hash": null } ] } ``` - List Payouts - Filtered by Payout Method Type - ```curl 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 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "7f9e25ac-cfe5-498d-a5bf-566f7f194d9a" }, "data": [ { "id": "payout_f2a413634e3d60ce17f27010d77054a1", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 110, "payout_currency": "EUR", "sender_amount": 110, "sender_currency": "EUR", "status": "Completed", "sender_country": "DK", "sender": { "id": "sender_3e92c5047e1f92e7a19e991d15a439a7", "first_name": "John Doe", "country": "DK", "entity_type": "individual", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_861005e8403f3e91b7a270eeb5f75ece", "first_name": "Jane", "country": "AT", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "phone_number": "436641234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "iban": "AT611904300234573201" }, "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": {}, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1762784444, "payout_fees": null, "expiration": null, "merchant_reference_id": "2025-11-10B", "paid_at": "1762784490", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 110, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "bgt26191-67ea-44f6-8eed-838a5e3c4344", "crypto_payout_hash": null }, { "id": "payout_53f4bb989121ebae9e7e8b3746bbccfe", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Completed", "sender_country": "DK", "sender": { "id": "sender_a64bb8e2f970181c5d40aff5ed3de93a", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "name": "Four Star Services", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "company_name": "Four Star Services", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_0bada697cbe155ee969e73691f53a83e", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773795, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1762785144", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 250.25, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "32126191-67ea-44f6-8eed-838a5e3c4nmh", "crypto_payout_hash": null }, { "id": "payout_42f2009733fca7f4a82a81893d731e91", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_abc7d5eae1cfe9aa1f5d677d3f4ff662", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_0bada697cbe155ee969e73691f53a83e", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773759, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [PAYER.COMPANY_NAME]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "61226191-67ea-44f6-8eed-838a5e3c4hyh", "crypto_payout_hash": null }, { "id": "payout_d845592cee8998bcc6e9256605e5c845", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_86357b6dbab0682b0e5c21588008ff8e", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_4c341a35620d16eb4710888c0c696572", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773707, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.POSTCODE]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "23426191-67ea-44f6-8eed-838a5e3c4hth", "crypto_payout_hash": null }, { "id": "payout_a7885752f09567e0f7e508bae27ab29b", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_1e45efb3d799ceadd4a965ea328fc309", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_e9c960b491a12f1b55af0a2f30e84be9", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773624, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "INVALID_REQUIRED_FIELD - [ADDRESS]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "bgt26191-67ea-44f6-8eed-838a5e3c4bng", "crypto_payout_hash": null }, { "id": "payout_b7ead4883e684839798e6cc8b53ccd74", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_6bdb646e765f4ba30923fb93a2cf474b", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_cc70ef4b33662dcebab0209c4bc377b6", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773565, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.IBAN]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_7c54a9a05c24065b7bbe52b9d4b71b42", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_9b8932e75ed97493e7730dea20be8c8f", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_3989fbb4d373cc67d9a141a4167d0e66", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773526, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.PHONE_NUMBER]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "rth26191-67ea-44f6-8eed-838a5e3c4nht", "crypto_payout_hash": null }, { "id": "payout_6197ef8daebc7b6ee332a28d90d4aaea", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_96ebac56f20a8135c210a8993409f6f3", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_fdc66f4c65bd0028ae064851e8aaeb05", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "city": "Anytown", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773470, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.DATE_OF_BIRTH]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_b046c72732f17313e9bbc3a3188f43ed", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 93.56, "payout_currency": "EUR", "sender_amount": 100.45, "sender_currency": "USD", "status": "Created", "sender_country": "DK", "sender": { "id": "sender_ad094d810b8f8a36a21942a525ac3531", "country": "DK", "entity_type": "company", "address": "123 First Street", "name": "John Doe", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "company_name": "John Doe", "currency": "USD", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_e3dc7e3c6e21ab54221743773b1a750b", "first_name": "Jane", "country": "AT", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "phone_number": "436641234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "iban": "AT611904300234573201" }, "fx_rate": 0.9314382272, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "amount": 100.45, "percent": 100 } ], "metadata": {}, "description": "Payout to card ID", "created_at": 1762772091, "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, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_8d6c025819115a30f80e6f6f761bbab4", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 93.56, "payout_currency": "EUR", "sender_amount": 100.45, "sender_currency": "USD", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_1686a4971578f3406b4f85e5d598952c", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "USD", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_1d3dea236dda4c24fece2093d95c53b8", "first_name": "Jane", "country": "AT", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "phone_number": "436641234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "iban": "AT611904300234573201" }, "fx_rate": 0.9314382272, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "instructions_value": {}, "ewallets": [ { "ewallet_id": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "amount": 100.45, "percent": 100 } ], "metadata": {}, "description": "Payout to card ID", "created_at": 1762772079, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [PAYER.COMPANY_NAME]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "34326191-67ea-44f6-8eed-838a5e3c477t", "crypto_payout_hash": null } ] } ``` - List Payouts - Filtered by batch_token - ```curl curl -X get 'https://sandboxapi.rapyd.net/v1/payouts?batch_token=batch_732c3395e01484ac5cdaa7592a92f009' \ \ -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' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "013b8c85-8fe6-4fca-aad0-aa0bef155811" }, "data": [ { "id": "payout_e61bb6994a98544edf23e5ddf21f4532", "payout_type": "bank", "payout_method_type": "new_bank", "amount": 285, "payout_currency": "EUR", "sender_amount": 285, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "mass sender company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "John", "first_name": "Doe", "country": "NL", "entity_type": "individual", "name": "John Dow", "currency": "EUR", "bank_name": "New Bank", "iban": "NL0XXXXXXXXXXXXXX" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 285, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807277, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 285, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_eadf57b73fb2ed639a211a5e8130596f", "payout_type": "bank", "payout_method_type": "New Bank", "amount": 255, "payout_currency": "EUR", "sender_amount": 255, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "Acme company", "company_name": "Acme", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "Doe", "first_name": "John", "country": "NL", "entity_type": "individual", "name": "John Doe", "currency": "EUR", "bank_name": "First Bank.", "iban": "NL0XXXXXXXXXXX" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 255, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807277, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 255, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_71780fd76db4b3f78384acfd78307e61", "payout_type": "bank", "payout_method_type": "New Bank", "amount": 280, "payout_currency": "EUR", "sender_amount": 280, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "mass sender company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "John", "first_name": "Doe", "country": "NL", "entity_type": "individual", "name": "John Doe", "currency": "EUR", "bank_name": "ABN AMRO BANK N.V.", "iban": "NL0XXXXXXXXXXXX" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 280, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807277, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 280, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_8ec664b6f713c7ba746d4b0b3c084e98", "payout_type": "bank", "payout_method_type": "New Bank", "amount": 300, "payout_currency": "EUR", "sender_amount": 300, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "Acme", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "John", "first_name": "Doe", "country": "NL", "entity_type": "individual", "name": "MASS BENE", "currency": "EUR", "bank_name": "New Bank.", "iban": "NL00123456789" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 300, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807274, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 300, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": "grg26191-67ea-44f6-8eed-838a5e3c46rgr", "crypto_payout_hash": null }, { "id": "payout_f1c5f3f2d2216b39735a97660556d1d5", "payout_type": "bank", "payout_method_type": "new_bank", "amount": 305, "payout_currency": "EUR", "sender_amount": 305, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "sample company", "company_name": "mass sample company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "John", "first_name": "Doe", "country": "NL", "entity_type": "individual", "name": "John Doe", "currency": "EUR", "bank_name": "First Bank", "iban": "NL0XXX123456789" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 305, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807274, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 305, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": "89026191-67ea-44f6-8eed-838a5e3c4n56", "crypto_payout_hash": null }, { "id": "payout_7ede0065c89e98ac6b99ea1190f5fdb9", "payout_type": "bank", "payout_method_type": "new_bank", "amount": 225, "payout_currency": "EUR", "sender_amount": 225, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "mass sender company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "John", "first_name": "Doe", "country": "NL", "entity_type": "individual", "name": "John Doe", "currency": "EUR", "bank_name": "sample bank", "iban": "NL02ABNA0123456789" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 225, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807274, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 225, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": "89026191-67ea-44f6-8eed-838a5e3c4tht", "crypto_payout_hash": null }, { "id": "payout_f7c2b9f4dc86427d7b2e40f15808f3ce", "payout_type": "bank", "payout_method_type": "sample_bank", "amount": 270, "payout_currency": "EUR", "sender_amount": 270, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "mass sender company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "Jane", "first_name": "Doe", "country": "NL", "entity_type": "individual", "name": "Jane Doe", "currency": "EUR", "bank_name": "ABN AMRO BANK N.V.", "iban": "NL0212345678989" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 270, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807274, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 270, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_ceaa6e11df9faa1c5edf88ee692148e1", "payout_type": "bank", "payout_method_type": "sample_bank", "amount": 275, "payout_currency": "EUR", "sender_amount": 275, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "mass sender company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "BENE", "first_name": "MASS", "country": "NL", "entity_type": "individual", "name": "MASS BENE", "currency": "EUR", "bank_name": "First Bank", "iban": "NL02ABABCDEFG" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 275, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807274, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 275, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": "edr26191-67ea-44f6-8eed-838a5e3c4jjy", "crypto_payout_hash": null }, { "id": "payout_9a68f304dc305ab25bd0aaa3e516ad80", "payout_type": "bank", "payout_method_type": "sample_bank", "amount": 140, "payout_currency": "EUR", "sender_amount": 140, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "mass sender company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "Jane", "first_name": "Smith", "country": "NL", "entity_type": "individual", "name": "Jane Smith", "currency": "EUR", "bank_name": "New Bank", "iban": "NL02AXXXXXXXXX" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 140, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807271, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807365", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 140, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": "3ed26191-67ea-44f6-8eed-838a5e3c4mju", "crypto_payout_hash": null }, { "id": "payout_4c311af85324126b1787806891eb674c", "payout_type": "bank", "payout_method_type": "sample_bank", "amount": 185, "payout_currency": "EUR", "sender_amount": 185, "sender_currency": "EUR", "status": "Completed", "sender_country": "AU", "sender": { "id": "sender_904e0c0bbdd55a700cad69230a090456", "country": "AU", "entity_type": "company", "name": "mass sender company", "company_name": "mass sender company", "currency": "EUR" }, "beneficiary_country": "NL", "beneficiary": { "id": "beneficiary_562f8aa62a3f1600b3a1df77de9666fc", "last_name": "BENE", "first_name": "MASS", "country": "NL", "entity_type": "individual", "name": "MASS BENE", "currency": "EUR", "bank_name": "ABN AMRO BANK N.V.", "iban": "NL02ABNA0123456789" }, "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_5301b81433c9ad0ba951bb2e2fe513f4", "amount": 185, "percent": 100 } ], "metadata": {}, "description": null, "created_at": 1690807271, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1690807364", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 185, "statement_descriptor": null, "gc_error_code": null, "batch_file": "batch_732c3395e01484ac5cdaa7592a92f009", "uetr": "76726191-67ea-44f6-8eed-838a5e3c46y7", "crypto_payout_hash": null } ] } ``` - List Payouts - with bin details - ```curl curl -X get 'https://sandboxapi.rapyd.net/v1/payouts?sender_currency=EUR' \ -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' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "e9983337-4e79-405b-b1b0-6ec050b6f441" }, "data": [ { "id": "payout_f2a413634e3d60ce17f27010d77054a1", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 110, "payout_currency": "EUR", "sender_amount": 110, "sender_currency": "EUR", "status": "Completed", "sender_country": "DK", "sender": { "id": "sender_3e92c5047e1f92e7a19e991d15a439a7", "first_name": "John Doe", "country": "DK", "entity_type": "individual", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_861005e8403f3e91b7a270eeb5f75ece", "first_name": "Jane", "country": "AT", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "phone_number": "436641234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "iban": "AT611904300234573201" }, "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": {}, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1762784444, "payout_fees": null, "expiration": null, "merchant_reference_id": "2025-11-10B", "paid_at": "1762784490", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 110, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "76726191-67ea-44f6-8eed-838a5e3c46yn", "crypto_payout_hash": null }, { "id": "payout_53f4bb989121ebae9e7e8b3746bbccfe", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Completed", "sender_country": "DK", "sender": { "id": "sender_a64bb8e2f970181c5d40aff5ed3de93a", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "name": "Four Star Services", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "company_name": "Four Star Services", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_0bada697cbe155ee969e73691f53a83e", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773795, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": "1762785144", "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 250.25, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "76726191-67ea-44f6-8eed-838a5e3c467t", "crypto_payout_hash": null }, { "id": "payout_42f2009733fca7f4a82a81893d731e91", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_abc7d5eae1cfe9aa1f5d677d3f4ff662", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_0bada697cbe155ee969e73691f53a83e", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773759, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [PAYER.COMPANY_NAME]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_d845592cee8998bcc6e9256605e5c845", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_86357b6dbab0682b0e5c21588008ff8e", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_4c341a35620d16eb4710888c0c696572", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123MainStreet", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773707, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.POSTCODE]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "crypto_payout_hash": null }, { "id": "payout_a7885752f09567e0f7e508bae27ab29b", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_1e45efb3d799ceadd4a965ea328fc309", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_e9c960b491a12f1b55af0a2f30e84be9", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "iban": "AT611904300234573201", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773624, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "INVALID_REQUIRED_FIELD - [ADDRESS]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "76726191-67ea-44f6-8eed-838a5e3c46oo", "crypto_payout_hash": null }, { "id": "payout_b7ead4883e684839798e6cc8b53ccd74", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_6bdb646e765f4ba30923fb93a2cf474b", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_cc70ef4b33662dcebab0209c4bc377b6", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "phone_number": "436641234568", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773565, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.IBAN]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": null, "crypto_payout_hash": null }, { "id": "payout_7c54a9a05c24065b7bbe52b9d4b71b42", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_9b8932e75ed97493e7730dea20be8c8f", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_3989fbb4d373cc67d9a141a4167d0e66", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "date_of_birth": "22/02/1980", "city": "Anytown", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773526, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.PHONE_NUMBER]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "767yh191-67ea-44f6-8eed-838a5e3c46hy", "crypto_payout_hash": null }, { "id": "payout_6197ef8daebc7b6ee332a28d90d4aaea", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 250.25, "payout_currency": "EUR", "sender_amount": 250.25, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_96ebac56f20a8135c210a8993409f6f3", "first_name": "John Doe", "country": "DK", "entity_type": "company", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_fdc66f4c65bd0028ae064851e8aaeb05", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "address": "123 Main Street", "name": "John Doe", "city": "Anytown", "account_number": "1234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "bin_details": { "type": "DEBIT", "brand": "VISA", "level": "CLASSIC", "issuer": "CONOTOXIA SP. Z O.O", "country": "PL", "bin_number": "411111" }, "bic_swift": "BKAUATWW", "card_expiration_year": "30", "card_expiration_month": "12", "card_number": "1111", "payment_type": "priority", "category": "card", "default_payout_method_type": "xx_mastercardglobal_card" }, "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": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773470, "payout_fees": null, "expiration": null, "merchant_reference_id": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [BENEFICIARY.DATE_OF_BIRTH]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "76726191-67ea-44f6-8eed-838a5e3c46ii", "crypto_payout_hash": null }, { "id": "payout_322a76b6db7caba4e2c724e543c82491", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 110, "payout_currency": "EUR", "sender_amount": 110, "sender_currency": "EUR", "status": "Canceled", "sender_country": "DK", "sender": { "id": "sender_24ce5a9fde75125e36d5b4ba457ff616", "first_name": "John Doe", "country": "DK", "entity_type": "individual", "address": "123 First Street", "date_of_birth": "22/02/1980", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_31b1d2244d7278d7c696d53e92588e62", "first_name": "Jane", "country": "AT", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "phone_number": "436641234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "iban": "AT611904300234573201" }, "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": {}, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1762771170, "payout_fees": null, "expiration": null, "merchant_reference_id": "2025-11-10B", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "76726191-67ea-44f6-8eed-838a5e3c46yl", "crypto_payout_hash": null }, { "id": "payout_3f387220f90b7c93e7e9dca3f83e84bb", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 110, "payout_currency": "EUR", "sender_amount": 110, "sender_currency": "EUR", "status": "Error", "sender_country": "DK", "sender": { "id": "sender_1e8bb07e326c351ffa2a57281f72ea85", "first_name": "John Doe", "country": "DK", "entity_type": "individual", "address": "123 First Street", "date_of_incorporation": "31/12/2000", "postcode": "12345", "city": "Anytown", "phone_number": "436641234568", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_0a6789a49bae68a15ecb6287f17b7016", "first_name": "Jane", "country": "US", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "phone_number": "436641234567", "currency": "EUR", "identification_type": "identification_id", "identification_value": "*********", "iban": "AT611904300234573201" }, "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": {}, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1762770702, "payout_fees": null, "expiration": null, "merchant_reference_id": "2025-11-10B", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": "MISSING_PAYOUT_METHOD_REQUIRED_FIELD - [PAYER.DATE_OF_BIRTH]", "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "uetr": "8y1026191-67ea-44f6-8eed-838a5e3c4a17", "crypto_payout_hash": null } ] } ``` - Bad Request - Invalid Limit - ```curl curl -X get 'https://sandboxapi.rapyd.net/v1/payouts?limit=1.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' ``` - ```json { "status": { "error_code": "INVALID_LIMIT", "status": "ERROR", "message": "The request tried to retrieve a list of objects, but the 'limit' query parameter was not set to a valid value. The request was rejected. Corrective action: Set 'limit' to an integer between 1 and 100.", "response_code": "INVALID_LIMIT", "operation_id": "9974da75-1587-4853-aece-c426c3b6deb0" } } ``` - Unauthorized - ```curl curl -X get 'https://sandboxapi.rapyd.net/v1/payoutss' \ -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' ``` - ```json { "status": { "error_code": "UNAUTHORIZED_API_CALL", "status": "ERROR", "message": "", "response_code": "UNAUTHORIZED_API_CALL", "operation_id": "69e6a091-e158-488b-b5e2-4c727805d0f0" } } ```