Create Sender
Create a sender for use in payouts.
The response produces a unique sender ID, which you can use in place of the sender object for Create Payout.
Note
In addition to the required fields documented below, you must include all other sender fields listed in the response to , and you must conform to the regex provided. To create a sender that you can use with multiple payout methods, include all fields that are required by each payout method. The client is responsible for including all required fields.
The code samples include successful requests (200) and bad requests (400).
For error messages that appear due to bad requests (400), see: General Errors
For information about unauthorized request (401) and other authentication errors, see Troubleshooting Authentication and Authorization Errors.
/v1/payouts/sender
Create Sender - individual
curl -X post 'https://sandboxapi.rapyd.net/v1/payouts/sender' \ -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 '{ "country": "US", "currency": "USD", "entity_type": "individual", "first_name": "Jane", "last_name": "Doe", "identification_type": "identification_id", "identification_value": "987654321", "date_of_birth": "12/25/2000", "address": "1 Second Street", "city": "Anytown", "state": "", "postcode": "12345" }'{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "cde4fe59-9c2e-4723-9dae-c1e1a467eef8" }, "data": { "id": "sender_2a2c042807ee053582f817ec37c89fc1", "last_name": "Doe", "first_name": "Jane", "country": "US", "entity_type": "individual", "address": "1 Second Street", "name": "Jane Doe", "date_of_birth": "12/25/2000", "postcode": "12345", "city": "Anytown", "currency": "USD", "identification_type": "identification_id", "identification_value": "987654321" } }
Create Sender - company
curl -X post 'https://sandboxapi.rapyd.net/v1/payouts/sender' \ -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 '{ "company_name": "Four Star Professional Services", "country": "US", "currency": "USD", "entity_type": "company", "identification_type": "company_registered_number", "identification_value": "0123456789", "purpose_code": "Transfer" }'{ "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "b44d86ca-2afd-4ec8-a7ef-95a3f1689c6a" }, "data": { "id": "sender_6fc83863c4cdb018260bb35c60949afc", "country": "US", "entity_type": "company", "name": "Four Star Professional Services", "company_name": "Four Star Professional Services", "currency": "USD", "identification_type": "company_registered_number", "identification_value": "0123456789", "purpose_code": "Transfer" } }
Bad Request - Entity Type Missing
curl -X post 'https://sandboxapi.rapyd.net/v1/payouts/sender' \ -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 '{ "country": "US", "currency": "USD", "first_name": "Jane", "last_name": "Doe", "identification_type": "identification_id", "identification_value": "987654321", "date_of_birth": "12/25/2000", "address": "1 Second Street", "city": "Anytown", "postcode": "12345" }'{ "status": { "error_code": "ERROR_MISSING_PAYOUT_SENDER_ENTITY_TYPE", "status": "ERROR", "message": "The request attempted an operation that requires the entity type of the sender, but the entity type was not found. The request was rejected. Corrective action: Set the sender entity type to 'individual' or 'company'.", "response_code": "ERROR_MISSING_PAYOUT_SENDER_ENTITY_TYPE", "operation_id": "ea988b6a-eb45-43de-b33b-28be139c791f" } }
Bad Request - Country Missing
curl -X post 'https://sandboxapi.rapyd.net/v1/payouts/sender' \ -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 '{ "currency": "USD", "entity_type": "individual", "first_name": "Jane", "last_name": "Doe", "identification_type": "identification_id", "identification_value": "987654321", "date_of_birth": "12/25/2000", "address": "1 Second Street", "city": "Anytown", "postcode": "12345" }'{ "status": { "error_code": "ERROR_CREATE_SENDER_COUNTRY_NOT_VALID", "status": "ERROR", "message": "The request tried to create a sender for a payout, but the country was missing or not recognized. The request was rejected. Corrective action: In the 'country' field, use the correct 2-letter ISO 3166-1 ALPHA-2 code.", "response_code": "ERROR_CREATE_SENDER_COUNTRY_NOT_VALID", "operation_id": "600b0cab-a283-45fe-aa9c-e214af886c9b" } }