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 if the payout method requires the action of a third party.
This method triggers the 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 is also triggered.
The following asynchronous webhooks provide information about later changes to the Payout object:
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 and Get Payout Required Fields.
Clients with PCI 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_automaticallyis set to false, you must confirm creation of the payout with the FX rate included in the response by running 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_requiredis set to true, you must run Set Payout Response to accept or decline the payout.For payout sandbox simulations , see Testing for Payout API
Code Samples
.NET
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
const makeRequest = require('<path-to-your-utility-file>/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 $path = $_SERVER['DOCUMENT_ROOT']; $path .= "/<path-to-your-utility-file>/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
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 -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 '{ "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 } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "e85516a8-b295-4626-8b6e-323bdef2f435" }, "data": { "id": "payout_a7e3bc0c1a955b9d587bc43db551323a", "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_51467a0aafc437a28967df129dbd5e7a", "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_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 objects", "created_at": 1701346573, "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" } }
Payout - Bank Transfer: Beneficiary/Sender IDs
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 '{ "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 } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "c1474e02-7e7f-4a40-85c0-b77123dc5bfe" }, "data": { "id": "payout_90430bf475b4a02179e2597e2eccb8da", "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": 1701347645, "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" } }
Payout to Local eWallet
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_method_type": "ke_mpesa_ewallet", "confirm_automatically": true, "payout_amount": 10, "payer_country": "US", "payer_currency": "USD", "beneficiary_country": "KE", "payout_currency": "KES", "beneficiary_entity_type": "individual", "beneficiary": { "first_name": "John", "last_name": "Doe", "phone_number": "+254987655555", "address": "6th street", "date_of_birth": "1999-01-01", "identification_value": "123456789" }, "payer_entity_type": "company", "payer": { "company_name": "Acme, Inc.", "address": "7th street", "city": "New Town", "postcode": "12345", "incorporation_number": "6tgwey", "date_of_incorporation": "1999-03-12", "purpose_code": "Proceeds_for_construction_services" } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "716a8ed3-0d1c-4ffb-a18d-ad9683167096" }, "data": { "id": "payout_9218a0acf6262638f436da3520fa4aa1", "payout_type": "ewallet", "payout_method_type": "ke_mpesa_ewallet", "amount": 10, "payout_currency": "KES", "sender_amount": 0.07, "sender_currency": "USD", "status": "Created", "sender_country": "US", "sender": { "id": "sender_fd824bc7a4336b609a3a5e22cb1f26f6", "country": "US", "entity_type": "company", "address": "7th street", "name": "Acme, Inc.", "date_of_incorporation": "1999-03-12", "postcode": "12345", "city": "New Town", "company_name": "Acme, Inc.", "currency": "USD", "purpose_code": "Proceeds_for_construction_services" }, "beneficiary_country": "KE", "beneficiary": { "id": "beneficiary_e6ac289f188f8f522ef49606074332a0", "last_name": "Doe", "first_name": "John", "country": "KE", "entity_type": "individual", "address": "6th street", "name": "John Doe", "date_of_birth": "1999-01-01", "phone_number": "+254987655555", "currency": "KES", "identification_value": "*********" }, "fx_rate": 153.01774929, "instructions": { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the specified ewallet of the beneficiary." } ] }, "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 0.07, "percent": 100 } ], "metadata": {}, "created_at": 1704797044, "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" } }
Payout with FX - Rate Confirmation Required
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 '{ "beneficiary": "beneficiary_d75798c2168f04a552542880ba772966", "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": "sender_94e84ba869e20da70be5b0c0027c889d", "sender_country": "MX", "sender_currency": "USD", "sender_entity_type": "company", "statement_descriptor": "RIDE MX payout monthly", "metadata": { "merchant_defined": true } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "acacbe8d-3543-4ddb-8cb7-850aa0cfcfbe" }, "data": { "id": "payout_15f6e010f75702209df917a1e3b46b5f", "payout_type": "bank", "payout_method_type": "mx_abc_capital_bank", "amount": 2000, "payout_currency": "MXN", "sender_amount": 119.09, "sender_currency": "USD", "status": "Confirmation", "sender_country": "US", "sender": { "id": "sender_94e84ba869e20da70be5b0c0027c889d", "country": "US", "entity_type": "company", "address": "address 2", "name": "Rapyd", "postcode": "3333", "city": "Amsterdam", "phone_number": "19019044444", "company_name": "Rapyd", "currency": "USD", "identification_value": "unc_num_123333", "province": "Amsterdam", "occupation": "Ridesharing" }, "beneficiary_country": "MX", "beneficiary": { "id": "beneficiary_d75798c2168f04a552542880ba772966", "last_name": "Doe", "first_name": "Jane", "country": "MX", "entity_type": "individual", "name": "Jane Doe", "currency": "MXN", "bank_name": "Jane Doe", "category": "bank" }, "fx_rate": 16.7938622, "instructions": {}, "ewallets": [ { "ewallet_id": "ewallet_4f1757749b8858160274e6db49f78ff3", "amount": 119.09, "percent": 100 } ], "metadata": { "merchant_defined": true }, "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": "NOT_IMPLEMENTED", "batch_file": null, "estimated_time_of_arrival": null } }
Payout with FX - Automatic Rate Confirmation
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 '{ "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", "metadata": { "merchant_defined": true } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "311afcf4-5074-432d-98cf-e17597f7fbf6" }, "data": { "id": "payout_60dca835ac0b2c822f76c48641d8bae0", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 2000, "payout_currency": "SGD", "sender_amount": 1544.58, "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.29485397, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861", "amount": 1544.58, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Salary", "created_at": 1701684409, "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" } }
Payout to Card
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 '{ "ewallet": "ewallet_4f1757749b8858160274e6db49f78ff3", "payout_amount": 250, "payout_method_type": "us_visa_card", "sender_currency": "USD", "sender_country": "US", "beneficiary": { "email": "janedoe@Rapyd.net ", "card_number": "4111111111111111", "card_expiration_month": "11", "card_expiration_year": "24", "card_cvv": "123", "first_name": "Jane", "last_name": "Doe" }, "beneficiary_country": "US", "payout_currency": "USD", "sender_entity_type": "company", "beneficiary_entity_type": "individual", "sender": { "company_name": "RideShare", "postcode": "WSQ12", "city": "Any Town", "state": "New State", "address": "123 1st ave." }, "description": "Payout to card", "statement_descriptor":"monthly expenses-part time" } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "d3e883aa-f306-465a-9ab4-ac66fc0d2557" }, "data": { "id": "payout_c59bb548e39cd9afa9a3238df83ddb3b", "payout_type": "card", "payout_method_type": "us_visa_card", "amount": 250, "payout_currency": "USD", "sender_amount": 250, "sender_currency": "USD", "status": "Completed", "sender_country": "US", "sender": { "id": "sender_d59e97c04385d2af91936749faff10ac", "country": "US", "entity_type": "company", "address": "123 1st ave.", "name": "RideShare", "postcode": "WSQ12", "city": "Any Town", "state": "New State", "company_name": "RideShare", "currency": "USD" }, "beneficiary_country": "US", "beneficiary": { "id": "beneficiary_109bf92da26b40cadced4f012d8a89e6", "last_name": "Doe", "first_name": "Jane", "country": "US", "entity_type": "individual", "name": "Jane Doe", "currency": "USD", "email": "janedoe@Rapyd.net ", "card_expiration_year": "24", "card_expiration_month": "11", "card_number": "1111" }, "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_4f1757749b8858160274e6db49f78ff3", "amount": 250, "percent": 100 } ], "metadata": {}, "description": "Payout to card", "created_at": 1701607413, "payout_fees": null, "expiration": null, "merchant_reference_id": "", "paid_at": null, "identifier_type": null, "identifier_value": null, "error": null, "paid_amount": 250, "statement_descriptor": "monthly expenses-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" } }
Payout to Card: Beneficiary Object with card_id
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 } '{ "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" } }
Payout with FX - Fixed Sender Amount
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 '{ "beneficiary": "beneficiary_81fdb04df9cc01c0488dcbbf02c76edd", "beneficiary_country": "sg", "beneficiary_entity_type": "individual", "confirm_automatically": true, "description": "Salary", "ewallet": "ewallet_6bf0e86b4c5e451691cf1f4e88b52eec", "sender_amount": "2000", "payout_currency": "sgd", "payout_method_type": "sg_ocbc_bank", "sender": "sender_94e84ba869e20da70be5b0c0027c889d", "sender_country": "us", "sender_currency": "usd", "sender_entity_type": "company", "statement_descriptor": "Salary-monthly-part-time", "metadata": { "merchant_defined": true } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "1a67fc33-8b37-470a-b1f6-332fe13137dc" }, "data": { "id": "payout_3df8720f731379f6d3e21e819ce4d750", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 2587.19, "payout_currency": "sgd", "sender_amount": 2000, "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.29359588, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_6bf0e86b4c5e451691cf1f4e88b52eec", "amount": 2000, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Salary", "created_at": 1701609492, "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" } }
Payout with FX - Fixed Payout Amount
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 '{ "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", "metadata": { "merchant_defined": true } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "3bc50846-871d-4b60-91bc-f4081cfc2e11" }, "data": { "id": "payout_2f985148d37867dcc0c1c84532179e82", "payout_type": "bank", "payout_method_type": "sg_ocbc_bank", "amount": 38000, "payout_currency": "sgd", "sender_amount": 29375.48, "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.29359588, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary" } ] } ], "ewallets": [ { "ewallet_id": "ewallet_6bf0e86b4c5e451691cf1f4e88b52eec", "amount": 29375.48, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Salary", "created_at": 1701610499, "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" } }
Payout with Fees
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 '{ "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", "metadata": { "merchant_defined": true } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "a5905a16-3d7d-4589-904e-dbbbf96ace4b" }, "data": { "id": "payout_45c32d9a1e8a93a3b12ccde923422779", "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_69a7b88bcc979c89f5f813b9198c85ba", "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_8495e5f5f2580b9cc5bf6f8a595e887a", "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": 1701611066, "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" } }
Payout to Rapyd Wallet - Confirmation Required
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_method_type": "rapyd_ewallet", "ewallet": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "description": "Confirmation Required", "payout_amount": "100", "payout_currency": "sgd", "sender_country": "us", "sender_currency": "usd", "sender_entity_type": "individual", "beneficiary_entity_type": "individual", "beneficiary_country": "sg", "beneficiary": { "confirmation_required": true, "ewallet": "ewallet_5a8973b94513036d5f87418eda29e15d" } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "4dfec10f-2553-4450-b0b5-a5bae51f9c46" }, "data": { "id": "payout_c4cdb4c09f12e13669343545ac1fe2bd", "payout_type": "rapyd_ewallet", "payout_method_type": "rapyd_ewallet", "amount": 100, "payout_currency": "sgd", "sender_amount": 77.36, "sender_currency": "usd", "status": "Confirmation", "sender_country": "us", "sender": { "country": "us", "entity_type": "individual", "currency": "usd" }, "beneficiary_country": null, "beneficiary": { "currency": "sgd", "ewallet": "ewallet_5a8973b94513036d5f87418eda29e15d", "confirmation_required": true }, "fx_rate": 1.2926705, "instructions": {}, "ewallets": [ { "ewallet_id": "ewallet_a2231b55c5ba23d904131d749f7ac62b", "amount": 77.36, "percent": 100 } ], "metadata": {}, "description": "Confirmation Required", "created_at": 0, "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": "NOT_IMPLEMENTED", "batch_file": null, "estimated_time_of_arrival": null } }
Payout - Estimated Time of Arrival
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 '{ "beneficiary": { "payment_type": "priority", "address": "1 First Avenue", "city": "Vienna", "country": "AT", "first_name": "John", "last_name": "Doe", "iban": "GB29NWBK60161331926819" }, "confirm_automatically": true, "beneficiary_entity_type": "individual", "payout_amount": 2, "payout_currency": "EUR", "payout_method_type": "eu_sepa_bank", "sender": { "company_name": "Acme", "address": "2 Second Avenue", "city": "Copenhagen", "country": "DK", "date_of_birth": "27/09/1980", "postcode": "67899", "identification_type":"incorporation_number", "identification_value":"123464" }, "sender_country": "DK", "sender_currency": "USD", "sender_entity_type": "company" } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "89fc1d6b-a77e-45e6-b96c-b2fa1913bd9d" }, "data": { "id": "payout_ff65ccd8b0d72a4d8815f7505c7502cf", "payout_type": "bank", "payout_method_type": "eu_sepa_bank", "amount": 2, "payout_currency": "EUR", "sender_amount": 2.24, "sender_currency": "USD", "status": "Created", "sender_country": "DK", "sender": { "id": "sender_ae35934b3a24216fe11ddfda24b27917", "country": "DK", "entity_type": "company", "name": "Jane Doe", "company_name": "Acme", "currency": "USD" }, "beneficiary_country": "AT", "beneficiary": { "id": "beneficiary_995bc4956db754f9cfe7b66f20fa7b67", "last_name": "Doe", "first_name": "John", "country": "AT", "entity_type": "individual", "name": "John Doe", "currency": "EUR", "iban": "GB29NWBK60161331926819" }, "fx_rate": 0.8943885, "instructions": [{ "name": "instructions", "steps": [{ "step1": "The funds will be transferred to the provided account details of the beneficiary." } ] } ], "ewallets": [{ "ewallet_id": "ewallet_a5d0ff1865fe71967d64a294dbd1de22", "amount": 2.24, "percent": 100 } ], "metadata": {}, "created_at": 1680092948, "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, "estimated_time_of_arrival": "The beneficiary will receive the funds within 5 minutesThe beneficiary will receive the funds in a few minutes." } }
Payout - On Hold
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 '{ "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": "BG96611020345678", "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_9bc4ba65f0c4bf9f86d843920525e3a5", "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", "metadata": { "merchant_defined": true } } '{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "f93e9d57-70db-4177-a203-0daf74fd3568" }, "data": { "id": "payout_0e7987911f4131fed2c8132ca378f387", "payout_type": "bank", "payout_method_type": "gb_local_bank", "amount": 223, "payout_currency": "GBP", "sender_amount": 281.51, "sender_currency": "USD", "status": "Hold", "sender_country": "NL", "sender": { "id": "sender_8dc0dd53b017425311b3066a3a85b53e", "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_023925515b8776feee14b15f30f7f0c6", "last_name": "Doe", "first_name": "John", "country": "GB", "entity_type": "individual", "address": "456 Second Street", "name": "John Doe", "postcode": "10101", "city": "Anytown", "account_number": "BG96611020345678", "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.79215, "instructions": [ { "name": "instructions", "steps": [ { "step1": "The funds will be transferred to the provided account details of the beneficiary." } ] } ], "ewallets": [ { "ewallet_id": "ewallet_9bc4ba65f0c4bf9f86d843920525e3a5", "amount": 281.51, "percent": 100 } ], "metadata": { "merchant_defined": true }, "description": "Payout - Bank Transfer: Beneficiary/Sender objects", "created_at": 1708525206, "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": "NOT_IMPLEMENTED", "batch_file": null, "estimated_time_of_arrival": null } }