Payouts

Initiate payout via supported currencies

post
/v1/transactions/initiate-payout
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:
amountnumberRequired

The amount to be debited for the payout

Example: 100
subCustomerIdstringOptional
quoteIdstringOptional
descriptionstringOptional
referencestringOptional
purposestringOptional
beneficiaryAccountIdstringRequired
Responses
200

Payout initiated successfully

No content

post
/v1/transactions/initiate-payout
POST /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