Create a payout
Arguments
recipient
string
conditional
A public address linked to the customer. Require if the destination object is empty.
account_id
string
conditional
Customer account id on merchant side. Require if the destination object is empty.
amount
integer
true
The amount to be payout to the customer in the minor currency.
currency
string
true
The valid ISO code 3 currency code to create the payout.
expires_at
int
true
Time at which the voucher will be expired. Measured in seconds since the Unix epoch.
recipient_name
string
false
Customer fist name and last name on merchant database.
metadata
hash
false
A set of key-value pairs that you can attach to a payout object. It can be useful for storing additional information about the payout in a structured format.
deposit
bool
false
Create a deposit voucher and assign it to the customer.
destination[type]
enum
conditional
Type of destination. One of bank_account
.
destination[account_number]
string
conditional
The account number for the bank account, in string formaat. Must be a checking account.
destination[routing_number]
string
conditional
Routing number of the bank used for transaction.
destination[swift_code]
string
optional
The account swift code for international transfers.
destination[bank_name]
string
optional
Name of the bank used for transaction.
destination[holder_name]
string
optional
Account holder name of the bank account used for transaction.
destination[holder_type]
enum
optional
What type of the bank account used for transaction. Possible values: business, individual.
destination[saving]
boolean
optional
True if destination bank account is a saving account.
POST
https://{domain given}/v2/payouts
The above command returns JSON structured like this:
Last updated