
Seamless payouts within your app
About payouts
Payouts enables users to seamlessly and instantly make withdrawals and refunds from the app or service that they are using.
Product Features
Instant
Running on UK Faster Payments rails, users see Payouts arrive in their accounts right away.
Easy to integrate
Integrate Payment Initiation and Payouts with one API to save time and avoid manual mistakes.
Verified
With Payouts and Auth, users’ bank details are auto-populated to ensure you are making a payout to a valid account.
Low cost
Cut hefty costs from cards and acquirers with low fixed-fee payments.
Create payout request
http code 200
{
"client_id": String, Required,
"secret": String, Required,
"idempotency_key": String, Required,
"wallet_id": String, Required,
"reference": String, Required,
"amount": {
"iso_currency_code": String,
"value": Number,
}, Required,
"counterparty": {
"name": String, Required,
"numbers": {
"bacs": {
"account_number": String,
"sort_code": String,
}, Required,
}, Required,
}, Required,
}
Create a Payout
The /wallet/transaction/execute endpoints allows you to create a payout
idempotency_key
Provide a unique key to prevent duplicate payouts
wallet_id
e-money account from which to transfer money
amount
Value in specified currency
counterparty
The destination account
Payout response
The /wallet/transaction/execute endpoint returns a transaction_id, status, and request_id
transaction_id
The payout identifier which can later be retrieved
status
Returns the status of the payment
Get payout response
http code 200
{
"request_id": String,
"transaction_id": String,
"status": String,
}