--- title: "Create Payout" source_url: https://docs.rapyd.net/en/create-payout.html lang: en --- # Create Payout Create a payout (disbursement). To simulate a payout to a card, use card number **4111111111111111**. To complete your simulation in the sandbox, you must run [Complete Payout](https://docs.rapyd.net/en/complete-payout.md "Complete Payout") if the payout method requires the action of a third party. This method triggers the [Payout Created Webhook](https://docs.rapyd.net/en/payout-created-webhook.md "Payout Created Webhook"). This webhook contains the same information as the response. If the action of a third party is not required, the [Payout Completed Webhook](https://docs.rapyd.net/en/payout-completed-webhook.md "Payout Completed Webhook") is also triggered. The following asynchronous webhooks provide information about later changes to the Payout object: - [Payout Expired Webhook](https://docs.rapyd.net/en/payout-expired-webhook.md "Payout Expired Webhook") - [Payout Failed Webhook](https://docs.rapyd.net/en/payout-failed-webhook.md "Payout Failed Webhook") - [Payout Returned Webhook](https://docs.rapyd.net/en/payout-returned-webhook.md "Payout Returned Webhook") - [Payout Updated Webhook](https://docs.rapyd.net/en/payout-updated-webhook.md "Payout Updated Webhook") > **Note:** > > - Before you call this method, you must determine which payout methods are valid for the country, and which fields are required for the payout method. Use [List Payout Method Types](https://docs.rapyd.net/en/list-payout-method-types.md "List Payout Method Types") and [Get Payout Required Fields](https://docs.rapyd.net/en/get-payout-required-fields.md "Get Payout Required Fields"). > - Clients with [PCI](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_pci_level_1 "PCI Level 1") certification can make a payout to a card. > - Requests for very small amounts are rounded down to zero, are not processed and throw an error. This can occur in payouts with FX. > - If you create a payout with FX and `confirm_automatically` is set to **false**, you must confirm creation of the payout with the FX rate included in the response by running [Confirm Payout with FX](https://docs.rapyd.net/en/confirm-payout-with-fx.md "Confirm Payout with FX") within a short time. The exact amount of time varies from payout method to payout method. > - If you create a payout to a Rapyd Wallet and `beneficiary.confirmation_required` is set to **true**, you must run [Set Payout Response](https://docs.rapyd.net/en/set-payout-response.md "Set Payout Response") to accept or decline the payout. > - For payout sandbox simulations, see [Testing for Payout API](https://docs.rapyd.net/en/testing-for-payout-api.md "Testing for Payout API"). > - A PayFac can create a payout on behalf of a submerchant. See the code sample "PayFac - Payout from Submerchant's Wallet". > - A merchant that operates multiple lines of business (MLOB) may initiate payouts on behalf of a specific business line by passing the corresponding business wallet in the `merchant_ewallet` field.  See the code sample "Payout from MLOB Business Wallet". > - 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 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**. - - idempotency - A unique key that prevents the platform from creating the same object twice. See [Idempotency](https://docs.rapyd.net/en/idempotency.md "Idempotency"). - - 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). ### Request Body Parameters - - beneficiary - One of the following: - String starting with **beneficiary_**. The response to [Create Beneficiary](https://docs.rapyd.net/en/create-beneficiary.md "Create Beneficiary") provides the ID of the `beneficiary` object. - Object describing the beneficiary. Must include all [Create Beneficiary](https://docs.rapyd.net/en/create-beneficiary.md "Create Beneficiary") fields and all fields in the response to [Get Payout Required Fields](https://docs.rapyd.net/en/get-payout-required-fields.md "Get Payout Required Fields"). - - beneficiary_country - Beneficiary bank country. The country to which funds are sent. Two-letter ISO 3166-1 ALPHA-2 code. - - beneficiary_entity_type - The beneficiary entity type. Valid values are `individual` and `company`. - - confirm_automatically - Determines whether the payout requires confirmation of the FX rate. One of the following: Relevant to payouts with FX. - **true** - The payout is created immediately. - **false** - The payout is created after you confirm the FX rate by a separate API call to [Confirm Payout with FX](https://docs.rapyd.net/en/confirm-payout-with-fx.md "Confirm Payout with FX"). false - - description - Description of the payout transaction. - - ewallet - ID of the wallet that the money is transferred from. String starting with **ewallet_**. - - merchant_reference_id - Identifier defined by the client for reference purposes. Limit: 45 characters. - - merchant_ewallet - ID of the client wallet of the sub-merchant. String starting with **ewallet_**. Required for payouts from a PayFac. See the example entitled, "Payout from Submerchant's Wallet". - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - payout_amount - Amount received by the beneficiary, in units of the currency defined in `payout_currency`. Decimal. Required when `sender_amount` is not used. - - 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. - - sender - One of the following: - String starting with **sender_**. The response to [Create Sender](https://docs.rapyd.net/en/create-sender.md "Create Sender") provides the ID of the 'sender' object. - Object describing the sender. Must include all fields in the [Sender](https://docs.rapyd.net/en/sender.md "Sender") object, and all fields in the response to [Get Payout Required Fields](https://docs.rapyd.net/en/get-payout-required-fields.md "Get Payout Required Fields"). - - 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. Required when `payout_amount` is not used. - - 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. Takes precedence over `sender.currency`. - - sender_entity_type - The sender entity type. Valid values are `individual` and `company`. - - statement_descriptor - A `statement` that includes the reason for the payout. Limited to 35 characters. ### 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. ### Code Samples - - .NET - ```csharp using System; using System.Text.Json; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { var requestObj = new { beneficiary = new { name = "Jane Doe", address = "456 Second Street", email = "janedoe@rapyd.net", country = "US", city = "Anytown", postcode = "10101", account_number = "BG96611020345678", bank_name = "US General Bank", state = "NY", identification_type = "SSC", identification_value = "123456789", bic_swift = "BUINBGSF", ach_code = "123456789" }, beneficiary_country = "US", beneficiary_entity_type = "individual", description = "Payout - Bank Transfer: Beneficiary/Sender objects", merchant_reference_id = "GHY-0YU-HUJ-POI", ewallet = "ewallet_090e1ef18c3aa754fd43cce9ee454858", payout_amount = "110", payout_currency = "USD", payout_method_type = "us_general_bank", sender = new { name = "John Doe", address = "123 First Street", city = "Anytown", state = "NY", date_of_birth = "22/02/1980" postcode = "12345", remitter_account_type = "Individual", source_of_income = "salary", identification_type = "License No", identification_value = "123456789", purpose_code = "ABCDEFGHI", account_number = "123456789", beneficiary_relationship = "client" }, sender_country = "US", sender_currency = "USD", sender_entity_type = "individual", metadata = new { merchant_defined = true } }; string request = JsonSerializer.Serialize(requestObj); string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/payouts", request); 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 body = { beneficiary: { name: 'Jane Doe', address: '456 Second Street', email: 'janedoe@rapyd.net', country: 'US', city: 'Anytown', postcode: '10101', account_number: 'BG96611020345678', bank_name: 'US General Bank', state: 'NY', identification_type: 'SSC', identification_value: '123456789', bic_swift: 'BUINBGSF', ach_code: '123456789' }, beneficiary_country: 'US', beneficiary_entity_type: 'individual', description: 'Payout - Bank Transfer: Beneficiary/Sender objects', merchant_reference_id: 'GHY-0YU-HUJ-POI', ewallet: 'ewallet_090e1ef18c3aa754fd43cce9ee454858', payout_amount: 110, payout_currency: 'USD', payout_method_type: 'us_general_bank', sender: { name: 'John Doe', address: '123 First Street', city: 'Anytown', state: 'NY', date_of_birth: '22/02/1980', postcode: '12345', remitter_account_type: 'Individual', source_of_income: 'salary', identification_type: 'License No', identification_value: '123456789', purpose_code: 'ABCDEFGHI', account_number: '123456789', beneficiary_relationship: 'client' }, sender_country: 'US', sender_currency: 'USD', sender_entity_type: 'individual', metadata: { merchant_defined: true } }; const result = await makeRequest('POST', '/v1/payouts', body); console.log(result); } catch (error) { console.error('Error completing request', error); } } ``` - - PHP - ```php /utilities.php"; include($path); try { $payout = [ "beneficiary" => array( "name" => "Jane Doe", "address" => "456 Second Street", "email" => "janedoe@rapyd.net", "country" => "US", "city" => "Anytown", "postcode" => "10101", "account_number" => "BG96611020345678", "bank_name" => "US General Bank", "state" => "NY", "identification_type" => "SSC", "identification_value" => "123456789", "bic_swift" => "BUINBGSF", "ach_code" => "123456789" ), "beneficiary_country" => "US", "beneficiary_entity_type" => "individual", "description" => "Payout - Bank Transfer => Beneficiary/Sender objects", "merchant_reference_id" => "GHY-0YU-HUJ-POI", "ewallet" => "ewallet_090e1ef18c3aa754fd43cce9ee454858", "payout_amount" => "110", "payout_currency" => "USD", "payout_method_type" => "us_general_bank", "sender" => array( "name" => "John Doe", "address" => "123 First Street", "city" => "Anytown", "state" => "NY", "date_of_birth" => "22/02/1980", "postcode" => "12345", "remitter_account_type" => "Individual", "source_of_income" => "salary", "identification_type" => "License No", "identification_value" => "123456789", "purpose_code" => "ABCDEFGHI", "account_number" => "123456789", "beneficiary_relationship" => "client" ), "sender_country" => "US", "sender_currency" => "USD", "sender_entity_type" => "individual", "metadata" => array( "merchant_defined" => true ) ]; $object = make_request('post', '/v1/payouts', $payout); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?> ``` - - Python - ```python from pprint import pprint from utilities import make_request payout_body = { "beneficiary": { "name": "Jane Doe", "address": "456 Second Street", "email": "janedoe@rapyd.net", "country": "US", "city": "Anytown", "postcode": "10101", "account_number": "BG96611020345678", "bank_name": "US General Bank", "state": "NY", "identification_type": "SSC", "identification_value": "123456789", "bic_swift": "BUINBGSF", "ach_code": "123456789" }, "beneficiary_country": "US", "beneficiary_entity_type": "individual", "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "merchant_reference_id": "GHY-0YU-HUJ-POI", "ewallet": "ewallet_090e1ef18c3aa754fd43cce9ee454858", "payout_amount": "110", "payout_currency": "USD", "payout_method_type": "us_general_bank", "sender": { "name": "John Doe", "address": "123 First Street", "city": "Anytown", "state": "NY", "date_of_birth": "22/02/1980", "postcode": "12345", "remitter_account_type": "Individual", "source_of_income": "salary", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "ABCDEFGHI", "account_number": "123456789", "beneficiary_relationship": "client" }, "sender_country": "US", "sender_currency": "USD", "sender_entity_type": "individual", "metadata": { "merchant_defined": True } } result = make_request(method='post', path='/v1/payouts', body=payout_body) pprint(result) ``` - /v1/payouts - Payout - Bank Transfer: Beneficiary/Sender objects - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "beneficiary": { "first_name": "Jane", "last_name": "Doe", "name": "Jane Doe", "address": "456 Second Street", "email": "janedoe@rapyd.net", "country": "US", "city": "Anytown", "postcode": "10101", "account_number": "BG96611020345678", "bank_name": "sg_ocbc_bank", "state": "NY", "identification_type": "SSC", "identification_value": "123456789", "bic_swift": "ABCDSGGG", "ach_code": "123456789" }, "beneficiary_country": "SG", "beneficiary_entity_type": "individual", "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "merchant_reference_id": "GHY-0YU-HUJ-POI", "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": "110", "payout_currency": "SGD", "payout_method_type": "sg_ocbc_bank", "sender": { "name": "John Doe", "address": "123 First Street", "city": "Anytown", "state": "NY", "date_of_birth": "22/02/1980", "postcode": "12345", "remitter_account_type": "Individual", "source_of_income": "salary", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "computer_services", "account_number": "123456789", "beneficiary_relationship": "client" }, "sender_country": "SG", "sender_currency": "SGD", "sender_entity_type": "individual", "statement_descriptor":"800-123-4567", "metadata": { "merchant_defined": true } }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "6f63d3ea-3fe1-46a1-ba07-a635a86df285" }, "data": { "id": "payout_9a4ca5baa1eba8726cdb420e230be030", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 110, "payout_currency": "SGD", "sender_amount": 110, "sender_currency": "SGD", "status": "Created", "sender_country": "SG", "sender": { "id": "sender_71af042431a867fd72816bf9a32bd5d8", "country": "SG", "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": "SGD", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "computer_services", "beneficiary_relationship": "client", "source_of_income": "salary" }, "beneficiary_country": "SG", "beneficiary": { "id": "beneficiary_df640a0444fb9a397e541643392f36f3", "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, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 110, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1755523533, "payout_fees": null, "expiration": null, "merchant_reference_id": "GHY-0YU-HUJ-POI", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "800-123-4567", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method.", "crypto_payout_hash": null } } ``` - Payout - Bank Transfer: Beneficiary/Sender IDs - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "beneficiary": "beneficiary_81fdb04df9cc01c0488dcbbf02c76edd", "beneficiary_country": "SG", "beneficiary_entity_type": "individual", "description": "Payout - Bank Transfer: Beneficiary/Sender IDs", "merchant_reference_id": "GHY-0YU-HUJ-POI", "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": "110", "payout_currency": "SGD", "payout_method_type": "sg_ocbc_bank", "sender": "sender_94e84ba869e20da70be5b0c0027c889d", "sender_country": "SG", "sender_currency": "SGD", "sender_entity_type": "company", "statement_descriptor": "800-123-4567", "metadata": { "merchant_defined": true } }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "d2622e92-6e86-4c77-95d6-1ecdd14bb427" }, "data": { "id": "payout_acd9082ceb008c1c197e0b68e19165cc", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 110, "payout_currency": "SGD", "sender_amount": 110, "sender_currency": "SGD", "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": "SGD", "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, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 110, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Payout - Bank Transfer: Beneficiary/Sender IDs", "created_at": 1755523814, "payout_fees": null, "expiration": null, "merchant_reference_id": "GHY-0YU-HUJ-POI", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "800-123-4567", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method.", "crypto_payout_hash": null } } ``` - Payout to Local eWallet - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "payout_method_type": "ng_paga_ewallet", "confirm_automatically": true, "payout_amount": 1001, "payer_country": "NG", "payer_currency": "GBP", "beneficiary_country": "NG", "payout_currency": "NGN", "beneficiary_entity_type": "individual", "beneficiary": { "name": "John", "surname": "Doe", "msisdn": "250700800900" }, "payer_entity_type": "company", "payer": { "company_name": "AcmeInc", "msisdn": "250700800901" } }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "fc5184e8-b769-41e9-abc1-3eb223c21885" }, "data": { "id": "payout_f6aa0a4c48fe12b5e197b4769617f54c", "payout_type": "ewallet", "payout_method_type": "ng_paga_ewallet", "amount": 1001, "payout_currency": "NGN", "sender_amount": 0.55, "sender_currency": "GBP", "status": "Created", "sender_country": "NG", "sender": { "id": "sender_cf1eb18dbdd9da1f038dde3221b1cb2f", "country": "NG", "entity_type": "company", "name": "AcmeInc", "company_name": "AcmeInc", "currency": "GBP" }, "beneficiary_country": "NG", "beneficiary": { "id": "beneficiary_421fca51b75e381fa695b84792dafc0a", "country": "NG", "entity_type": "individual", "name": "John", "currency": "NGN" }, "fx_rate": 1812.61663083, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the wallet provided by the beneficiary." } ] } ], "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 0.55, "percent": 100 } ], "metadata": {}, "created_at": 1755671900, "payout_fees": null, "expiration": 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, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method.", "crypto_payout_hash": null } } ``` - Payout with FX - Rate Confirmation Required - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "beneficiary": { "account_number": "321654987", "first_name": "John", "last_name": "Doe", "bank_account_type": "clabe" }, "beneficiary_country": "MX", "beneficiary_entity_type": "individual", "confirm_automatically": false, "description": "FX with confirmation", "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": "2000", "payout_currency": "MXN", "payout_method_type": "mx_abc_capital_bank", "sender": { "company_name": "SenderCompanyName" }, "sender_country": "MX", "sender_currency": "USD", "sender_entity_type": "company", "statement_descriptor": "RIDE MX payout monthly" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "14bef8ea-cf60-4c07-b694-150ac76aa204" }, "data": { "id": "payout_b5f468ba37f451d846eddcdc9b2d5bcb", "payout_type": "bank", "payout_method_type": "mx_abc_capital_bank", "amount": 2000, "payout_currency": "MXN", "sender_amount": 100.87, "sender_currency": "USD", "status": "Confirmation", "sender_country": "MX", "sender": { "country": "MX", "entity_type": "company", "name": "SenderCompanyName", "company_name": "SenderCompanyName", "currency": "USD" }, "beneficiary_country": "MX", "beneficiary": { "last_name": "Doe", "first_name": "John", "country": "MX", "entity_type": "individual", "name": "John Doe", "account_number": "321654987", "currency": "MXN", "bank_account_type": "clabe" }, "fx_rate": 19.82801735, "instructions": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 100.87, "percent": 100 } ], "metadata": {}, "description": "FX with confirmation", "created_at": 0, "payout_fees": null, "expiration": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "RIDE MX payout monthly", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": null, "crypto_payout_hash": null } } ``` - Payout with FX - Automatic Rate Confirmation - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' -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' \ --data-raw '{ "beneficiary": "beneficiary_81fdb04df9cc01c0488dcbbf02c76edd", "beneficiary_country": "SG", "beneficiary_entity_type": "individual", "confirm_automatically": true, "description": "Salary", "ewallet": "", "payout_amount": "2000", "payout_currency": "SGD", "payout_method_type": "sg_ocbc_bank", "sender": "sender_94e84ba869e20da70be5b0c0027c889d", "sender_country": "SG", "sender_currency": "USD", "sender_entity_type": "company", "statement_descriptor": "Salary-monthly-part-time" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "f7892e39-2614-446a-8a0d-b411c60638c4" }, "data": { "id": "payout_d77f780b483fa318e23e812801511b3b", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 2000, "payout_currency": "SGD", "sender_amount": 1532, "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": "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" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 1532, "percent": 100 } ], "metadata": {}, "description": "Salary", "created_at": 1755524218, "payout_fees": null, "expiration": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "Salary-monthly-part-time", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method.", "crypto_payout_hash": null } } ``` - Payout to Card - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": 250.25, "payout_method_type": "at_sepa_bank", "sender_currency": "EUR", "sender_country": "DK", "beneficiary": "beneficiary_0bada697cbe155ee969e73691f53a83e", "beneficiary_country": "AT", "payout_currency": "EUR", "sender_entity_type": "company", "beneficiary_entity_type": "individual", "sender": { "company_name": "Four Star Services", "first_name": "John Doe", "identification_type": "work_permit", "identification_value": "123456789", "phone_number": "436641234568", "address": "123 First Street", "source_of_income": "salary", "date_of_incorporation": "31/12/2000", "postcode": "12345", "date_of_birth": "22/02/1980", "city": "Anytown" }, "description": "Payout to card", "purpose_code": "remittances", "beneficiary_relationship": "supplier", "statement_descriptor":"spare parts" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "d084ba4c-53ca-4b15-b564-bc901d31355a" }, "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": "Created", "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": "*********", "merchant_reference_id": "2025-11-10b", "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" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 250.25, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1762773795, "payout_fees": null, "expiration": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "spare parts", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes.", "purpose_code": "remittances", "beneficiary_relationship": "supplier", "crypto_payout_hash": null } } ``` - Payout to Card: Beneficiary Object with card_id - ```curl curl -X post https://sandboxapi.rapyd.net/v1/payouts -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' -d '{ "payout_amount": 2.44, "payout_currency": "USD", "type": "card", "sender_currency": "USD", "sender_country": "US", "beneficiary_country": "US", "sender_entity_type": "company", "beneficiary_entity_type": "individual", "payout_method_type": "us_mastercard_card", "beneficiary": { "card_id": "card_34d9a74d81ba015f96a8066938d5fd37", "first_name": "John", "last_name": "Doe" }, "sender": { "company_name": "ACME Company", "postcode": "10001", "city": "New York", "state": "NY", "address": "123 First Avenue" }, "description": "Payout to card ID", "ewallet": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "confirm_automatically": true } ' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "22810b9e-5c63-4ec6-8561-d20358c6c4a4" }, "data": { "id": "payout_566902d9736ad607cdad7e94018520d0", "payout_type": "card", "payout_method_type": "us_mastercard_card", "amount": 2.44, "payout_currency": "USD", "sender_amount": 2.44, "sender_currency": "USD", "status": "Completed", "sender_country": "US", "sender": { "id": "sender_c540125118559a3f0794c5e661a5a4e2", "country": "US", "entity_type": "company", "address": "123 First Avenue", "name": "ACME Company", "postcode": "10001", "city": "New York", "state": "NY", "company_name": "ACME Company", "currency": "USD" }, "beneficiary_country": "US", "beneficiary": { "id": "beneficiary_10c7036adb90b6e4e43cac40c4b836fd", "last_name": "Doe", "first_name": "John", "country": "US", "entity_type": "individual", "name": "John Doe", "currency": "USD", "card_expiration_year": "24", "card_expiration_month": "03", "card_number": "0441" }, "fx_rate": 1, "instructions": { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided credit card of the beneficiary ." } ] }, "ewallets": [ { "ewallet_id": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "amount": 2.44, "percent": 100 } ], "metadata": {}, "description": "Payout to card ID", "created_at": 1701607763, "payout_fees": null, "expiration": null, "merchant_reference_id": "", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 2.44, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method", "crypto_payout_hash": null } } ``` - Payout with FX - Fixed Sender Amount - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "sender_amount": 100.45, "sender_currency": "USD", "payout_currency": "EUR", "sender_country": "DK", "beneficiary_country": "AT", "sender_entity_type": "company", "beneficiary_entity_type": "individual", "payout_method_type": "at_sepa_bank", "type": "card", "beneficiary": { "first_name": "Jane", "address": "456SecondStreet", "city": "Anytown", "postcode": "10101", "phone_number": "436641234567", "identification_type": "identification_id", "identification_value": "123456789", "date_of_birth": "15/12/1985", "iban": "AT611904300234573201" }, "sender": { "company_name": "John Doe", "identification_type": "work_permit", "identification_value": "123456789", "phone_number": "436641234568", "address": "123 First Street", "source_of_income": "salary", "date_of_incorporation": "31/12/2000", "postcode": "12345", "date_of_birth": "22/02/1980", "city": "Anytown" }, "purpose_code": "remittances", "beneficiary_relationship": "supplier", "description": "Payout to card ID", "ewallet": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "confirm_automatically": true }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "c04b1ae4-7a45-4762-b3b6-be9303e45069" }, "data": { "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" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "amount": 100.45, "percent": 100 } ], "metadata": {}, "description": "Payout to card ID", "created_at": 1762772091, "payout_fees": null, "expiration": 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, "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes.", "purpose_code": "remittances", "beneficiary_relationship": "supplier", "crypto_payout_hash": null } } ``` - Payout with FX - Fixed Payout Amount - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "beneficiary": "beneficiary_81fdb04df9cc01c0488dcbbf02c76edd", "beneficiary_country": "SG", "beneficiary_entity_type": "individual", "confirm_automatically": true, "description": "Salary", "ewallet": "ewallet_6bf0e86b4c5e451691cf1f4e88b52eec", "payout_amount": "38000", "payout_currency": "sgd", "payout_method_type": "sg_ocbc_bank", "sender": "sender_94e84ba869e20da70be5b0c0027c889d", "sender_country": "sg", "sender_currency": "USD", "sender_entity_type": "company", "statement_descriptor": "Salary-monthly-part-time" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "27313809-7c47-4900-b5f1-75b5c549c94d" }, "data": { "id": "payout_9d3a48f830f862311c26b0ae95ebdf01", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 38000, "payout_currency": "SGD", "sender_amount": 29108.09, "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": "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" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_6bf0e86b4c5e451691cf1f4e88b52eec", "amount": 29108.09, "percent": 100 } ], "metadata": {}, "description": "Salary", "created_at": 1755592415, "payout_fees": null, "expiration": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "Salary-monthly-part-time", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method.", "crypto_payout_hash": null } } ``` - Payout with Fees - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "ewallet": "ewallet_4434255c83c8c28113fe8b34b3260d0d", "merchant_reference_id": "G0GR-POYD-5uMK-96Q1", "payout_amount": 100, "payout_method_type": "sg_ocbc_bank", "sender_currency": "sgd", "sender_country": "sg", "beneficiary_country": "sg", "payout_currency": "sgd", "sender_entity_type": "company", "beneficiary_entity_type": "individual", "beneficiary": { "name": "Jane Doe", "first_name": "Jane", "last_name": "Doe", "address": "456 Second Street", "email": "janedoe@rapyd.net", "country": "sg", "city": "Anytown", "postcode": "10101", "account_number": "BG96611", "state": "South Region", "payment_type": "priority", "identification_type": "passport", "identification_value": "123456789", "bank_name": "sg_ocbc_bank", "bic_swift": "ABCDSGGG", "ach_code": "123456789" }, "sender": { "address": "123 First Street", "city": "Anytown", "state": "North Region", "date_of_birth": "22/02/1980", "postcode": "12345", "phonenumber": "621212938122", "remitter_account_type": "Individual", "source_of_income": "salary", "identification_type": "License No", "identification_value": "123456789", "bic_swift": "ABCDSGGG", "purpose_code": "salary", "account_number": "123456789", "beneficiary_relationship": "client", "company_name": "Acme music streaming services" }, "payout_fees": { "transaction_fee": { "calc_type": "gross", "fee_type": "absolute", "value": 2 }, "fx_fee": { "calc_type": "gross", "fee_type": "percentage", "value": 2.5 }, "description": "Salary payout - wallet to cash", "statement_descriptor": "Salary-monthly-part-time" } }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "5b179a30-6cfb-4f2c-aa65-e5b3800d727a" }, "data": { "id": "payout_65f34edabebf6a434383dee3c48224b2", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 100, "payout_currency": "SGD", "sender_amount": 104.5, "sender_currency": "SGD", "status": "Created", "sender_country": "sg", "sender": { "id": "sender_9b1276be2524ce2c3f3bdb6f377363cf", "country": "sg", "entity_type": "company", "address": "123 First Street", "name": "Acme music streaming services", "date_of_birth": "22/02/1980", "postcode": "12345", "city": "Anytown", "state": "North Region", "company_name": "Acme music streaming services", "account_number": "123456789", "currency": "SGD", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "salary", "beneficiary_relationship": "client", "source_of_income": "salary" }, "beneficiary_country": "SG", "beneficiary": { "id": "beneficiary_a4cbcd6bf1f3c43fb571afd821e98504", "last_name": "Doe", "first_name": "Jane", "country": "sg", "entity_type": "individual", "address": "456 Second Street", "name": "Jane Doe", "postcode": "10101", "city": "Anytown", "state": "South Region", "account_number": "BG96611", "currency": "SGD", "email": "janedoe@rapyd.net", "identification_type": "passport", "identification_value": "*********", "bank_name": "sg_ocbc_bank", "bic_swift": "ABCDSGGG", "ach_code": "123456789", "payment_type": "priority" }, "fx_rate": 1, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_4434255c83c8c28113fe8b34b3260d0d", "amount": 104.5, "percent": 100 } ], "metadata": {}, "created_at": 1755592541, "payout_fees": { "transaction_fee": { "calc_type": "gross", "value": 2, "fee_type": "absolute" }, "fx_fee": { "calc_type": "gross", "value": 2.5 }, "gross_fees": 4.5, "net_fees": 0 }, "expiration": null, "merchant_reference_id": "G0GR-POYD-5uMK-96Q1", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": null, "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method.", "crypto_payout_hash": null } } ``` - Payout to Rapyd Wallet - Confirmation Required - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "payout_method_type": "rapyd_ewallet", "ewallet": "ewallet_b5320c566cc4aa01fe77440ad08693f7", "description": "Confirmation Required", "payout_amount": "101", "payout_currency": "eur", "sender_country": "po", "sender_currency": "eur", "sender_entity_type": "individual", "beneficiary_entity_type": "individual", "beneficiary_country": "po", "beneficiary": { "confirmation_required": true, "ewallet": "ewallet_31fb2dbbaf6519461ee4fbe1062220d3" } }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "90292373-2206-4efa-ba51-c477216e1c03" }, "data": { "id": "payout_b380ca556ac03259d5d2b83dd4b5eaff", "payout_type": "rapyd_ewallet", "payout_method_type": "rapyd_ewallet", "amount": 101, "payout_currency": "EUR", "sender_amount": 101, "sender_currency": "EUR", "status": "Created", "sender_country": "po", "sender": { "id": "sender_6ab62a4b7c4182e7c529cad4407dcbb3", "country": "po", "entity_type": "individual", "currency": "EUR" }, "beneficiary_country": null, "beneficiary": { "id": "beneficiary_fb48a07e8f5e802f8764afff34a67b12", "currency": "EUR", "ewallet": "ewallet_31fb2dbbaf6519461ee4fbe1062220d3", "confirmation_required": true }, "fx_rate": 1, "instructions": [ {} ], "ewallets": [ { "ewallet_id": "ewallet_b5320c566cc4aa01fe77440ad08693f7", "amount": 101, "percent": 100 } ], "metadata": {}, "description": "Confirmation Required", "created_at": 1755755492, "payout_fees": null, "expiration": 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, "estimated_time_of_arrival": "An estimated receipt time is not yet available for this payout method.", "crypto_payout_hash": null } } ``` - Payout - Estimated Time of Arrival - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "beneficiary": { "first_name": "Jane", "last_name": "Doe", "name": "Jane Doe", "address": "456SecondStreet", "email": "janedoe@rapyd.net", "country": "US", "city": "Anytown", "postcode": "10101", "phone_number": "436641234567", "account_number": "AT96611020345678", "bank_name": "at_sepa_bank", "state": "NY", "identification_type": "identification_id", "identification_value": "123456789", "bic_swift": "BKAUATWWDIA", "ach_code": "123456789", "date_of_birth": "15/12/1985", "iban": "AT611904300234573201" }, "beneficiary_country": "AT", "beneficiary_entity_type": "individual", "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "merchant_reference_id": "2025-11-10B", "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": "110", "payout_currency": "EUR", "payout_method_type": "at_sepa_bank", "sender": { "first_name": "John Doe", "address": "123 First Street", "city": "Anytown", "state": "NY", "date_of_birth": "22/02/1980", "phone_number": "436641234568", "postcode": "12345", "remitter_account_type": "Individual", "source_of_income": "salary", "identification_type": "work_permit", "identification_value": "123456789", "purpose_code": "computer_services", "account_number": "123456789", "beneficiary_relationship": "client", "date_of_incorporation": "31/12/2000" }, "sender_country": "DK", "sender_currency": "EUR", "sender_entity_type": "individual", "statement_descriptor":"SPARE PARTS", "purpose_code": "remittances", "beneficiary_relationship": "supplier" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "498f0f09-d92c-4032-bbcb-1d1895f3430e" }, "data": { "id": "payout_ce70d6a3caec55dbcba256b51bfe50ed", "payout_type": "bank", "payout_method_type": "at_sepa_bank", "amount": 110, "payout_currency": "EUR", "sender_amount": 110, "sender_currency": "EUR", "status": "Created", "sender_country": "DK", "sender": { "id": "sender_df3a4b5e08983fc6af4f0ba448f21c6c", "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", "state": "NY", "phone_number": "436641234568", "account_number": "123456789", "currency": "EUR", "identification_type": "work_permit", "identification_value": "123456789", "purpose_code": "computer_services", "beneficiary_relationship": "client", "source_of_income": "salary" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_b7548f0d3316fded09fa0877e489d43a", "last_name": "Doe", "first_name": "Jane", "country": "US", "entity_type": "individual", "address": "456SecondStreet", "name": "Jane Doe", "date_of_birth": "15/12/1985", "postcode": "10101", "city": "Anytown", "state": "NY", "phone_number": "436641234567", "account_number": "AT96611020345678", "currency": "EUR", "email": "janedoe@rapyd.net", "identification_type": "identification_id", "identification_value": "*********", "bank_name": "at_sepa_bank", "bic_swift": "BKAUATWWDIA", "iban": "AT611904300234573201", "ach_code": "123456789" }, "fx_rate": 1, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 110, "percent": 100 } ], "metadata": {}, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1762769995, "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": "SPARE PARTS", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes.", "purpose_code": "remittances", "beneficiary_relationship": "supplier", "crypto_payout_hash": null } } ``` - Payout - On Hold - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "confirm_automatically": "true", "beneficiary": { "first_name": "John", "last_name": "Doe", "address": "456 Second Street", "email": "jdoe@rapyd.net", "country": "GB", "city": "Anytown", "postcode": "10101", "account_number": "BG966110", "bank_name": "gb_local_bank", "identification_type": "passport", "identification_value": "123456789", "sort_code": "123225", "bic_swift": "IIIGGB22", "ach_code": "123456789" }, "beneficiary_country": "GB", "beneficiary_entity_type": "individual", "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "merchant_reference_id": "GHY-1YU-HUJ-POI", "ewallet": "ewallet_c1943cfeda5f98247ab117e5d2648861", "payout_amount": "223", "payout_currency": "GBP", "payout_method_type": "gb_local_bank", "sender": { "first_name": "Jane", "last_name": "Doe", "address": "123 First Street", "city": "Anytown", "state": "NY", "date_of_birth": "22/02/1980", "postcode": "12345", "phonenumber": "621212938122", "remitter_account_type": "Individual", "source_of_income": "salary", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "ABCDEFGHI", "account_number": "123456789", "beneficiary_relationship": "client" }, "sender_country": "NL", "sender_currency": "USD", "sender_entity_type": "individual", "statement_descriptor": "GHY* Limited Access 800-123-4567" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "c99557b0-25c3-48bc-ac9a-109745490c76" }, "data": { "id": "payout_4179aba906b49b5cfa1a753e016be3fb", "payout_type": "bank", "payout_method_type": "gb_local_bank", "amount": 223, "payout_currency": "GBP", "sender_amount": 287.19, "sender_currency": "USD", "status": "Created", "sender_country": "NL", "sender": { "id": "sender_f616e06b7089e4451c69a924684d2865", "last_name": "Doe", "first_name": "Jane", "country": "NL", "entity_type": "individual", "address": "123 First Street", "name": "Jane 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": "GB", "beneficiary": { "id": "beneficiary_94ee7c3f6b5a23c9a327a923044629f9", "last_name": "Doe", "first_name": "John", "country": "GB", "entity_type": "individual", "address": "456 Second Street", "name": "John Doe", "postcode": "10101", "city": "Anytown", "account_number": "BG966110", "currency": "GBP", "email": "jdoe@rapyd.net", "identification_type": "passport", "identification_value": "*********", "bank_name": "gb_local_bank", "bic_swift": "IIIGGB22", "sort_code": "123225", "ach_code": "123456789" }, "fx_rate": 0.7764770018, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary." } ] } ], "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 287.19, "percent": 100 } ], "metadata": {}, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1768744782, "payout_fees": null, "expiration": null, "merchant_reference_id": "GHY-1YU-HUJ-POI", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "GHY* Limited Access 800-123-4567", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "The beneficiary will receive the funds within 3 hours.", "crypto_payout_hash": null } } ``` - Payout - USDC Stablecoin - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "sender_amount": 150, "beneficiary": { "company_name": "The Beneficiary Sample Company", "crypto_wallet_address": "0x03ae6765C6991813a3EAa86fe63ebBCA1c9EC", "crypto_wallet_protocol": "ERC20", "address": "21 West 23rd Street", "city": "AnyTown", "country": "DE", "identification_value": "31525791789" }, "beneficiary_country": "BE", "beneficiary_entity_type": "company", "payout_currency": "USDC", "payout_method_type": "xx_stablecoin_ewallet", "sender": { "company_name": "The Sender Sample Company" }, "confirm_automatically": true, "sender_country": "AU", "sender_currency": "USD", "sender_entity_type": "company", "description": "USDC payout" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "91b4438a-8d71-4f78-8456-3398cb6b78b3" }, "data": { "id": "payout_af135d565f6e67110949b7f8fc1b4349", "payout_type": "ewallet", "payout_method_type": "xx_stablecoin_ewallet", "amount": 138.23, "payout_currency": "USDC", "sender_amount": 150, "sender_currency": "USD", "status": "Created", "sender_country": "AU", "sender": { "id": "sender_2cac9e41b045aa7800f631e48c1e2f54", "country": "AU", "entity_type": "company", "name": "The Sender Sample Company", "company_name": "The Sender Sample Company", "currency": "USD" }, "beneficiary_country": "BE", "beneficiary": { "id": "beneficiary_b1b216e01d47be4082672dbb184f0ed4", "country": "DE", "entity_type": "company", "address": "21 West 23rd Street", "name": "The Beneficiary Sample Company", "city": "AnyTown", "company_name": "The Beneficiary Sample Company", "currency": "USDC", "identification_value": "***********", "crypto_wallet_address": "0x03ae6765C6991813a3EAa86fe63ebBCA1c9EC", "crypto_wallet_protocol": "ERC20" }, "fx_rate": 0.9215, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the Crypto wallet address of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 150, "percent": 100 } ], "metadata": {}, "description": "USDC payout", "created_at": 1762952499, "payout_fees": null, "expiration": 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, "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes.", "crypto_payout_hash": null } } ``` - Payout - USDC Stablecoin with Fees - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "amount": 25, "beneficiary": { "first_name": "John", "last_name": "Doe", "date_of_birth": "10/12/1990", "crypto_wallet_address": "0x02ae6765C6991813a3EAa86fe63ebBCA1c9EC156", "crypto_wallet_protocol": "ERC20", "address": "21 West 23rd Street", "city": "AnyTown", "country": "DE", "identification_value": "31425791789" }, "beneficiary_country": "RO", "beneficiary_entity_type": "individual", "description": "USDC payout with fees", "payout_currency": "USDC", "payout_method_type": "xx_stablecoin_ewallet", "sender": { "company_name": "The Sandy Company" }, "confirm_automatically": true, "sender_country": "AU", "sender_currency": "EUR", "sender_entity_type": "company", "payout_fees": { "fee_currency": "USD", "transaction_fee": { "calc_type": "net", "fee_type": "absolute", "value": 2 }, "fx_fee": { "calc_type": "net", "fee_type": "percentage", "value": 2.5 } } }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "526b5d60-060e-46a3-b65b-27d5f6671223" }, "data": { "id": "payout_209328b1d12186d25b7a0db930d27503", "payout_type": "ewallet", "payout_method_type": "xx_stablecoin_ewallet", "amount": 22.37, "payout_currency": "USDC", "sender_amount": 29.49, "sender_currency": "EUR", "status": "Created", "sender_country": "AU", "sender": { "id": "sender_3a1e2c44d68b52be21d630c94d475da3", "country": "AU", "entity_type": "company", "name": "The Sandy Company", "company_name": "The Sandy Company", "currency": "EUR" }, "beneficiary_country": "RO", "beneficiary": { "id": "beneficiary_6cf27a1a2add8c7c6f4409c8e4fef783", "last_name": "Doe", "first_name": "John", "country": "DE", "entity_type": "individual", "address": "21 West 23rd Street", "name": "John Doe", "date_of_birth": "10/12/1990", "city": "AnyTown", "currency": "USDC", "identification_value": "***********", "crypto_wallet_address": "0x02ae6765C6991813a3EAa86fe63ebBCA1c9EC156", "crypto_wallet_protocol": "ERC20" }, "fx_rate": 0.84778, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the Crypto wallet address of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 29.49, "percent": 100 } ], "metadata": {}, "description": "USDC payout with fees", "created_at": 1755592913, "payout_fees": { "transaction_fee": { "calc_type": "net", "value": 2, "fee_type": "absolute" }, "fx_fee": { "calc_type": "net", "value": 2.5 }, "gross_fees": 0, "net_fees": 2.69, "fee_currency": "USD" }, "expiration": 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, "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes.", "crypto_payout_hash": null } } ``` - Payout - USDT Stablecoin with Fees - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "amount": 43, "beneficiary": { "company_name": "Sample Company", "crypto_wallet_address": "0x02ae6765C6991813a3EAa86fe63ebBCA1c9EC156", "crypto_wallet_protocol": "ERC20", "address": "a2123", "city": "Anytown", "country": "DE", "identification_value": "31425791789" }, "beneficiary_country": "BE", "beneficiary_entity_type": "company", "description": "sample payout", "payout_currency": "USDT", "payout_method_type": "xx_stablecoin_ewallet", "sender": { "company_name": "Sender company" }, "payout_fees": { "fee_currency": "GBP", "transaction_fee": { "calc_type": "net", "fee_type": "absolute", "value": 2 }, "fx_fee": { "calc_type": "net", "fee_type": "percentage", "value": 2.5 } }, "confirm_automatically": true, "sender_country": "AU", "sender_currency": "EUR", "sender_entity_type": "company" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "17a3a8e4-a0eb-420b-868a-ebc449da8c4c" }, "data": { "id": "payout_8c86c969a7cf1723e568adcc1e2e44c6", "payout_type": "ewallet", "payout_method_type": "xx_stablecoin_ewallet", "amount": 39.92, "payout_currency": "USDT", "sender_amount": 50.72, "sender_currency": "EUR", "status": "Created", "sender_country": "AU", "sender": { "id": "sender_7819ecca3a3cd7b26f32e4a168a42f90", "country": "AU", "entity_type": "company", "name": "Sender company", "company_name": "Sender company", "currency": "EUR" }, "beneficiary_country": "BE", "beneficiary": { "id": "beneficiary_25d1f305dc1a3abe59e95c9d907f3c12", "country": "DE", "entity_type": "company", "address": "a2123", "name": "Sample Company", "city": "Anytown", "company_name": "Sample Company", "currency": "USDT", "identification_value": "***********", "crypto_wallet_address": "0x02ae6765C6991813a3EAa86fe63ebBCA1c9EC156", "crypto_wallet_protocol": "ERC20" }, "fx_rate": 0.84778, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the Crypto wallet address of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 50.72, "percent": 100 } ], "metadata": {}, "description": "sample payout", "created_at": 1755593027, "payout_fees": { "transaction_fee": { "calc_type": "net", "value": 2, "fee_type": "absolute" }, "fx_fee": { "calc_type": "net", "value": 2.5 }, "gross_fees": 0, "net_fees": 4.01, "fee_currency": "GBP" }, "expiration": 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, "estimated_time_of_arrival": "The beneficiary will receive the funds within few minutes.", "crypto_payout_hash": null } } ``` - PayFac - Payout from Submerchant's Wallet - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "merchant_ewallet": "ewallet_c034d9ed2b819a270a4a20afb427bae0", "amount": 100, "payout_amount": 15, "beneficiary": { "first_name": "Jane", "last_name": "Doe", "card_number": "4111111111111111", "city": "New Town", "address": "street 1", "postcode": "1234567", "state": "New State" }, "beneficiary_country": "IS", "beneficiary_entity_type": "individual", "payout_currency": "ISK", "payout_method_type": "xx_visa_card", "sender": { "company_name": "Sample company", "city": "New Town", "address": "35 East 56th street 5 New State Iceland" }, "confirm_automatically": true, "sender_country": "IS", "sender_currency": "USD", "sender_entity_type": "company", "beneficiary_relationship": "other", "statement_descriptor": "123456789" }' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "bf7cbf89-9ff6-41ef-b0ff-6e058649fd2c" }, "data": { "id": "payout_bde980b6eb9068f86148f4d86c66bded", "payout_type": "card", "payout_method_type": "xx_visa_card", "amount": 100, "payout_currency": "ISK", "sender_amount": 0.84, "sender_currency": "USD", "status": "Completed", "sender_country": "IS", "sender": { "id": "sender_3c7fe3160ad83e38f6492c7c72555b5b", "country": "IS", "entity_type": "company", "address": "35 East 56th street New State Iceland", "name": "John Doe", "city": "New Town", "company_name": "Sample company", "currency": "USD" }, "beneficiary_country": "IS", "beneficiary": { "id": "beneficiary_5d4b60d348af9143cecbf2ec130c4b31", "last_name": "Jane", "first_name": "Doe", "country": "IS", "entity_type": "individual", "address": "35 East 56th street Iceland", "name": "Jane Doe", "postcode": "1234567", "city": "New Town", "state": "New State", "currency": "ISK", "bin_details": { "type": "CREDIT", "brand": "VISA", "level": "", "issuer": "", "country": "US", "bin_number": "11111" }, "card_number": "1111" }, "fx_rate": 118.7259736553, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided card details of the beneficiary." } ] } ], "ewallets": [ { "ewallet_id": "ewallet_f69bdf976830363ec0146418f31ea4c1", "amount": 0.84, "percent": 100 } ], "metadata": {}, "description": "", "created_at": 1756450912, "payout_fees": null, "expiration": null, "merchant_reference_id": "", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 100, "statement_descriptor": "123456789", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "The beneficiary will receive the funds within 2 business days.", "beneficiary_relationship": "other", "merchant_ewallet": "ewallet_c034d9ed2b819a270a4a20afb427bae0", "crypto_payout_hash": null } } ``` - Payout from MLOB Business Wallet - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "confirm_automatically": true, "payout_amount": 30, "payout_method_type": "eu_sepa_bank", "sender_currency": "SGD", "sender_country": "GB", "payout_currency": "EUR", "sender_entity_type": "company", "beneficiary_entity_type": "company", "description": "MLOB demo", "statement_descriptor": "MLOB demo12345", "beneficiary_country": "GB", "beneficiary": { "company_name": "sample company", "address": "35 East 56th street New Town, UK", "bank_name": "DEMOBANK NA", "iban": "GB8DEMOIBAN123456", "sort_code": "123" }, "sender": { "company_name": "sample1 company" }, "ewallet":"ewallet_9d74addcd8a4b19042db304e304a171b", "merchant_ewallet": "ewallet_417ec6c2d02d8b14340e7689ed4aada3" } ' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "29903d1f-9324-49f5-8173-dd0f8ba35ac3" }, "data": { "id": "payout_5805298adab6c31d9b4be07589280926", "payout_type": "bank", "payout_method_type": "eu_sepa_bank", "amount": 30, "payout_currency": "EUR", "sender_amount": 46.56, "sender_currency": "SGD", "status": "Created", "sender_country": "GB", "sender": { "id": "sender_6d981a58e2d8ea5f363d7fb861890f49", "country": "GB", "entity_type": "company", "name": "John Doe", "company_name": "sample1 company", "currency": "SGD" }, "beneficiary_country": "GB", "beneficiary": { "id": "beneficiary_501cbfa07da67254d8753924dbab3491", "country": "GB", "entity_type": "company", "address": "35 East 56th street New Town, UK", "name": "Jane Doe", "company_name": "sample1 company", "currency": "EUR", "bank_name": "DEMOBANK NA", "iban": "GB8DEMOIBAN123456", "sort_code": "123" }, "fx_rate": 0.6443322654, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary." } ] } ], "ewallets": [ { "ewallet_id": "ewallet_9d74addcd8a4b19042db304e304a171b", "amount": 46.56, "percent": 100 } ], "metadata": {}, "description": "MLOB demo", "created_at": 1778653073, "payout_fees": null, "expiration": null, "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 0, "statement_descriptor": "MLOB demo12345", "gc_error_code": null, "batch_file": null, "estimated_time_of_arrival": "The beneficiary will receive the funds within 1 business day.", "merchant_ewallet": "ewallet_417ec6c2d02d8b14340e7689ed4aada3", "crypto_payout_hash": null } } ``` - Bad Request - Invalid Beneficiary Entity Type - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "beneficiary": { "first_name": "Jane", "last_name": "Doe", "name": "Jane Doe", "address": "456 Second Street", "email": "janedoe@rapyd.net", "country": "US", "city": "Anytown", "postcode": "10101", "account_number": "BG96611020345678", "bank_name": "sg_ocbc_bank", "state": "NY", "identification_type": "SSC", "identification_value": "123456789", "bic_swift": "ABCDSGGG", "ach_code": "123456789" }, "beneficiary_country": "SG", "beneficiary_entity_type": "person", "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "merchant_reference_id": "GHY-0YU-HUJ-POI", "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": "110", "payout_currency": "SGD", "payout_method_type": "sg_ocbc_bank", "sender": { "name": "John Doe", "address": "123 First Street", "city": "Anytown", "state": "NY", "date_of_birth": "22/02/1980", "postcode": "12345", "remitter_account_type": "Individual", "source_of_income": "salary", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "computer_services", "account_number": "123456789", "beneficiary_relationship": "client" }, "sender_country": "SG", "sender_currency": "SGD", "sender_entity_type": "individual", "statement_descriptor":"800-123-4567", "metadata": { "merchant_defined": true } }' ``` - ```json { "status": { "error_code": "INVALID_BENEFICIARY_PAYOUT_ENTITY_TYPE", "status": "ERROR", "message": "The request attempted an operation that requires the entity type of the beneficiary, but the value was not found or not recognized. The request was rejected. Corrective action: Set the 'beneficiary_entity_type' field to one of the following values: 'individual', 'company'.", "response_code": "INVALID_BENEFICIARY_PAYOUT_ENTITY_TYPE", "operation_id": "e6d94f30-1239-4d19-a5c3-48be4f47c493" } } ``` - Bad Request - Missing Payout Method Type - ```curl curl -X post 'https://sandboxapi.rapyd.net/v1/payouts' \ -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' \ --data-raw '{ "beneficiary": { "first_name": "Jane", "last_name": "Doe", "name": "Jane Doe", "address": "456 Second Street", "email": "janedoe@rapyd.net", "country": "US", "city": "Anytown", "postcode": "10101", "account_number": "BG96611020345678", "bank_name": "sg_ocbc_bank", "state": "NY", "identification_type": "SSC", "identification_value": "123456789", "bic_swift": "ABCDSGGG", "ach_code": "123456789" }, "beneficiary_country": "SG", "beneficiary_entity_type": "individual", "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "merchant_reference_id": "GHY-0YU-HUJ-POI", "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": "110", "payout_currency": "SGD", "sender": { "name": "John Doe", "address": "123 First Street", "city": "Anytown", "state": "NY", "date_of_birth": "22/02/1980", "postcode": "12345", "remitter_account_type": "Individual", "source_of_income": "salary", "identification_type": "License No", "identification_value": "123456789", "purpose_code": "computer_services", "account_number": "123456789", "beneficiary_relationship": "client" }, "sender_country": "SG", "sender_currency": "SGD", "sender_entity_type": "individual", "statement_descriptor":"800-123-4567", "metadata": { "merchant_defined": true } }' ``` - ```json { "status": { "error_code": "ERROR_MISSING_PAYOUT_METHOD_TYPE", "status": "ERROR", "message": "The request tried to create a payout, but the payout method type could not be determined. The request was rejected. Corrective action: Provide a valid string for 'payout_method_type', or provide valid values for 'identifier_type' and 'identifier_value'.", "response_code": "ERROR_MISSING_PAYOUT_METHOD_TYPE", "operation_id": "f923cc2f-638b-41fa-b7be-031d06ef44b6" } } ```