Create Sender
POST {{baseUrl}}/v1/payouts/sender
Create a sender for use in payouts. The response provides 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 Get Payout Required Fields, 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.
Request Body
{"country"=>"DJ", "currency"=>"YER", "entity_type"=>"company", "company_name"=>"<string>", "first_name"=>"<string>", "identification_type"=>"<string>", "identification_value"=>"<string>", "last_name"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"account_number":"\u003cstring\u003e","additional_data":{},"additional_last_name":"\u003cstring\u003e","address":"\u003cstring\u003e","bank_code":"\u003cstring\u003e","bank_name":"\u003cstring\u003e","beneficiary_relationship":"\u003cstring\u003e","city":"\u003cstring\u003e","company_name":"\u003cstring\u003e","country":"WF","currency":"SZL","date_of_birth":"\u003cstring\u003e","date_of_incorporation":"\u003cstring\u003e","email":"\u003cstring\u003e","entity_type":"company","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","id_date_of_issue":"\u003cstring\u003e","id_expiry":"\u003cstring\u003e","id_issue_authority":"\u003cstring\u003e","id_issue_location":"\u003cstring\u003e","identification_type":"\u003cstring\u003e","identification_value":"\u003cstring\u003e","last_name":"\u003cstring\u003e","merchant_reference_id":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","mobile_number":"\u003cstring\u003e","name":"\u003cstring\u003e","nationality":"\u003cstring\u003e","occupation":"\u003cstring\u003e","phone_country_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","purpose_code":"\u003cstring\u003e","source_of_income":"\u003cstring\u003e","state":"\u003cstring\u003e","suburb":"\u003cstring\u003e","tax_id":"\u003cstring\u003e"},"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}