Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB
Payouts
Initiate

post/payouts/create-bank-payout

Request body

amountnumber required
accountNumberstring required
accountNamestring required
currency'TZS' | 'USD' required

Account currency to pay out from (TZS or USD)

accountCurrency'TZS'

Receiving currency for the payout (TZS)

orderReferencestring required

Your unique Order reference

bicstring required

Beneficiary bank BIC. You can fetch the list of bank BICs from the banks list endpoint.

transferType'ACH' | 'RTGS' required
checksumstring

If enabled, this is the generated checksum of the payload. Refer to the documentation for more details.

Response

Create bank payout response

updatedAtstring date-time
createdAtstring date-time
idstring
orderReferencestring
amountstring

Total amount deducted from your account balance (includes fee)

currencystring
feestring

Transaction fee deducted from source currency (included in amount)

exchangedboolean

Indicates if currency conversion was applied (true when source currency differs from receiving currency)

status'AUTHORIZED' | 'SUCCESS' | 'REVERSED'
channel'BANK TRANSFER'
channelProviderstring
transferType'ACH' | 'RTGS' nullable
clientIdstring

Application Client ID associated with the payout

Example response

{
  "amount": "202360.00",
  "currency": "TZS",
  "fee": "2360.00",
  "exchanged": true,
  "exchange": {
    "sourceCurrency": "USD",
    "targetCurrency": "TZS",
    "sourceAmount": 1000,
    "rate": 2500
  },
  "channelProvider": "Equity Bank Tanzania Limited",
  "transferType": "ACH",
  "order": {
    "amount": "20000.00",
    "currency": "TZS"
  },
  "beneficiary": {
    "accountNumber": "123456789",
    "accountName": "John Doe"
  }
}