POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer Token, Where accessToken is the access token used to authenticate the request.

Headers

Accept-Language
string
default:en

Preferred language for the response

X-Idempotency-Key
string

A unique key to ensure idempotent requests

Body

application/json
merchantAccountNumber
integer
required

The merchant's account number

Example:

37463669

beneficiaryName
string
required

The recipient's name

Example:

"John Phiri"

connectorId
integer
required

ID of the payment connector to use. See Get Connectors for the full list of available connector IDs.

Example:

550044

beneficiaryAccountNumber
string
required

The recipient's account number

Example:

"1234568"

transactionDescription
string

Description of the transaction

Example:

"Salary Payment"

transactionAmount
number<double>

The amount to be disbursed

Example:

45000.55

sourceReferenceNumber
string

Reference number from the source system

Example:

"QKAHXD200923"

capturedBy
string<email>

Email address of the user who captured/created the transaction.

Example:

"johndoe@example.com"

Response

200 - application/json

200-OK

merchantAccountNumber
integer
Example:

37463669

transactionReferenceNumber
string
Example:

"251220XF152G"

responseCode
string
Example:

"S100"