Create Beneficiary
POST {{baseUrl}}/v1/payouts/beneficiary
Create a beneficiary for use in payouts. The response provides a unique beneficiary ID, which you can use in place of the Beneficiary object for Create Payout. This method triggers the Beneficiary Created webhook. This webhook contains the same information as the response. Note: In addition to the required fields documented below, you must include all other beneficiary fields listed in the response to Get Payout Required Fields, and you must conform to the regex provided. To create a beneficiary 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
{"category"=>"bank", "country"=>"VU", "currency"=>"BBD", "entity_type"=>"individual", "company_name"=>"<string>", "default_payout_method_type"=>"<string>", "first_name"=>"<string>", "identification_type"=>"<string>", "identification_value"=>"<string>", "last_name"=>"<string>", "merchant_reference_id"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"aba":"\u003cstring\u003e","account_number":"\u003cstring\u003e","ach_code":"\u003cstring\u003e","additional_data":{},"additional_last_name":"\u003cstring\u003e","address":"\u003cstring\u003e","bank_account_holder_name":"\u003cstring\u003e","bank_account_type":"\u003cstring\u003e","bank_address":"\u003cstring\u003e","bank_branch_code":"\u003cstring\u003e","bank_branch_name":"\u003cstring\u003e","bank_city":"\u003cstring\u003e","bank_code":"\u003cstring\u003e","bank_country":"\u003cstring\u003e","bank_name":"\u003cstring\u003e","bank_province":"\u003cstring\u003e","beneficiary_bic_local":"\u003cstring\u003e","beneficiary_relationship":"\u003cstring\u003e","bic_swift":"\u003cstring\u003e","bsb_code":"\u003cstring\u003e","card_expiration_month":"\u003cstring\u003e","card_expiration_year":"\u003cstring\u003e","card_number":"\u003cstring\u003e","category":"bank_redirect","city":"\u003cstring\u003e","clabe":"\u003cstring\u003e","cnaps":"\u003cstring\u003e","company_name":"\u003cstring\u003e","confirmation_required":"\u003cboolean\u003e","country":"TJ","currency":"INR","date_of_birth":"\u003cstring\u003e","date_of_incorporation":"\u003cstring\u003e","default_payout_method_type":"\u003cstring\u003e","email":"\u003cstring\u003e","entity_type":"company","ewallet":"\u003cstring\u003e","first_name":"\u003cstring\u003e","iban":"\u003cstring\u003e","id":"\u003cstring\u003e","id_date_of_issue":"\u003cstring\u003e","id_issue_authority":"\u003cstring\u003e","id_issue_location":"\u003cstring\u003e","identification_type":"\u003cstring\u003e","identification_value":"\u003cstring\u003e","ifsc":"\u003cstring\u003e","issuer_code":"\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","payment_type":"\u003cstring\u003e","phone_country_code":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","postcode":"\u003cstring\u003e","province":"\u003cstring\u003e","purpose_code":"\u003cstring\u003e","routing_code_type_1":"\u003cstring\u003e","routing_code_type_2":"\u003cstring\u003e","routing_code_type_3":"\u003cstring\u003e","routing_code_value_1":"\u003cstring\u003e","routing_code_value_2":"\u003cstring\u003e","routing_code_value_3":"\u003cstring\u003e","sort_code":"\u003cstring\u003e","state":"\u003cstring\u003e","statement_narrative":"\u003cstring\u003e","suburb":"\u003cstring\u003e","tax_id":"\u003cstring\u003e","vpa":"\u003cstring\u003e"},"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}