Payouts
Authorizations
ww-api-keystringRequired
Body
idempotencyKeystringRequired
Use this to prevent duplicate payouts. If a payout with the same idempotency key already exists, it will be rejected. The key can be any unique string or UUID.
fromall ofRequired
The wallet to be debited for the payout
string · enumOptionalPossible values:
toall ofRequired
The currency the beneficiary would be paid in
string · enumOptionalPossible values:
amountnumberRequiredExample:
The amount to be debited for the payout
100subCustomerIdstringOptional
quoteIdstringOptional
descriptionstringOptional
referencestringOptional
purposestringOptional
beneficiaryAccountIdstringRequired
Responses
200
Payout initiated successfully
No content
429
Too many requests
post
/v1/transactions/initiate-payoutPOST /v1/transactions/initiate-payout HTTP/1.1
Host: stage-capi.wewireafrica.com
ww-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"idempotencyKey": "text",
"from": "EUR",
"to": "EUR",
"amount": 100,
"subCustomerId": "text",
"quoteId": "text",
"description": "text",
"reference": "text",
"purpose": "text",
"beneficiaryAccountId": "text"
}No content
Last updated