Payouts

Payouts require a list of purposes. We use purpose codes to specify what purpose a payout is meant for, view the list of payout codes and descriptions here

Initiate payout via supported currencies

post

https://stage-capi.wewireafrica.comhttps://capi.wewireafrica.com

/v1/transactions/initiate-payout

Authorizations

ww-api-key

ww-api-keystringRequired

Body

application/json

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

The sub-customer to be debited for the payout

descriptionstringOptional

The description of the payout

referencestringOptional

The reference of the payout

purposeCodeall ofOptional

The purpose code of the payout. Must be one of the predefined purpose codes (e.g. POP001–POP032).

string · enumOptionalPossible values:

beneficiaryAccountIdstringRequired

The beneficiary account to be credited for the payout

supportingDocumentsstring[]Optional

Supporting documents for purpose of payment as base64 data URIs (max 5MB each, up to 3 files)

feePaymentModestring · enumOptional

Fee payment mode - IMMEDIATE (default) or PAY_LATER (requires DEFFERED_PAYOUT_FEES feature)

Possible values:

Responses

200

Payout initiated successfully

No content

429

Too many requests

post

/v1/transactions/initiate-payout

HTTPcURLJavaScriptPython

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: 238

{
  "idempotencyKey": "text",
  "from": "EUR",
  "to": "EUR",
  "amount": 100,
  "subCustomerId": "text",
  "description": "text",
  "reference": "text",
  "purposeCode": "POP001",
  "beneficiaryAccountId": "text",
  "supportingDocuments": [
    "text"
  ],
  "feePaymentMode": "IMMEDIATE"
}

No content