Overview
A payout is the transfer of funds to a bank account or other payment option. To receive funds (for you or your vendors), you can pay out from an existing account containing an available balance (payable_balance
).
Make sure to implement payout webhooks so you will get notified about your vendors activity
What you can do with the Payouts
- Send fast payouts to your Vendors' Bank account
- Send fast payouts to your Bank account
Scheduled Payout
You can decide whether you like to schedule payouts or perform an on-demand payout.
UNIPaaS allow you to schedule your own payouts and your vendor payouts. you can also schedule a payout for each vendor separately. If you embedded our vendor view in your admin, your vendors will be able to configure their own scheduled payouts.
You can learn more about scheduled payouts here
Before You Begin
- Make sure you have the relevant account ID
- Make sure you have the correct Vendor ID
- Make sure you have a relevant payout option configured or register new one
Request Payout
Requesting a payout consists of 2 steps:
- Create
- Commit / Cancel
Funds will be deducted from account on step 2 if a commit was made
The Payout Object
Parameter | Type | Description |
---|---|---|
'id' | Number | Unique id of payout object |
'ewallet_id' | String | account id of the payout balance |
'payout_option_id' | String | Payout option id of the payout |
'payout_method' | Enum | Payout method: bank_transfer |
'amount' | Number | Amount of the payout |
currency | Enum | account currency: 'USD', 'EUR', 'GBP' |
'status' | Enum | Payout's status: 'Pending', 'Succeeded', 'Failed' |
The Payout Option Object
Parameter | Type | Description |
---|---|---|
'id' | String | Unique id of payout option |
'identityType' | Enum | Identity Type: VENDOR |
'identity' | String | id of identity |
'payout_option_type' | Enum | Payout option types: 'Card', 'Alternative', 'Bank Account' |
'bank_account' | Object | For Payout Option 'Bank Account' only. |
'card_account' | Object | For Payout Option 'Card' only. |
'apm_account' | Object | For Payout Option 'Alternative' only. |
An example for 'bank_account' object:
{
"iban": "GB71BARC20032634966595",
"name": "Unipass docs example",
"country": "GB"
}
An example for 'apm_account' object:
{
"name": "Unipass docs example"
}
An example for 'card_account' object:
{
"brand": "VISA",
"issuer_country": "GB",
"program": "Visa Traditional",
"bin": "*******",
"expiration_month": "09",
"expiration_year": "22",
"last4Digits": "****"
}
Updated 5 months ago