Payout
Create a new payout
This endpoint create a new payout to a beneficiary. The payout only supported the same currency between payer and beneficiary.
POST
Header
string
required
x-client-id.string
required
Bearer
YOUR_TOKEN_HERE.Parameters
string
required
Amount to be paid.
string
required
Reason for the payment instruction.
string
Bank payment reference to be shown on beneficiary’s bank transaction history.
string
required
Date when payment should be made.
Format: YYYY-MM-DDstring
required
ID of the beneficiary.
string
required
Whether the current user is a payer.
One of
One of
Y, Nstring
ID of the payer.
string
Payer’s entity type.
One of
One of
individual, companystring
Payer’s company name.
required, if entity_type = companystring
Payer’s first name.
required, if entity_type = individualstring
Payer’s last name.
required, if entity_type = individualstring
Payer’s date of birth.
Format: YYYY-MM-DDrequired, if entity_type = individualstring
Payer’s country.
Two-letter ISO 3166-2 country code.
Two-letter ISO 3166-2 country code.
string
Payer’s address.
string
Payer’s city.
string
Payer’s state or province.
string
Payer’s postal code.
string
Payer’s identification type. Depends on the value of
entity_type.string
Payer’s identification value.
Response
number
Indicates whether the call was successful. 200 if successful, 400 if not.
string
Response Message. “Success” if successful, others not.