Skip to navigation

Create bank payout

View as Markdown

Sends a bank payout (cashout) from the merchant wallet. Currently for TZS bank transfers. Always send currency explicitly. x-idempotency-key is required. Generate a new UUID for each payout.

Authentication

x-api-keystring

Dashboard Public Key. Maps to x-api-key.

x-api-secretstring

Dashboard Secret Key. Maps to x-api-secret. Server-side only.

Headers

x-api-secretstringRequired
x-idempotency-keystringRequiredformat: "uuid"

Unique per payout. Generate a new UUID for each transfer (for example crypto.randomUUID() or a uuid library). Reuse the same value only to retry this exact request.

Request

This endpoint expects an object.
amountintegerRequired
Gross amount to debit from the merchant wallet, in major units.
currencyenumRequired

Wallet and payout currency. Bank payouts currently support TZS. Additional currencies (for example USD) will be documented when available.

Allowed values:
bankstringRequired

Bank shortcode, for example ABSA, CRDBBANK, NMB. Prefer the same value used at account-name lookup.

accountstringRequired
Beneficiary bank account number.
namestringRequired

Beneficiary name from account-name lookup.

Response

Payout accepted
statusstring
codeinteger
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error