Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB
Payouts
Preview

Validates bank payout details like amount, order-reference and verifies payout channels availability. When beneficiary name lookup is available for the selected bank, the response may include the account holder name.

post/payouts/preview-bank-payout

Request body

amountnumber required
accountNumberstring 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

Bank payout preview response

amountnumber

Total amount to be deducted from your account balance (includes fee)

balancenumber
channelProviderstring
feenumber

Transaction fee deducted from source currency (included in amount)

exchangedboolean

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

payoutFeeBearer'merchant' | 'both' | 'customer'
nameLookupStatus'RESOLVED' | 'UNAVAILABLE'

Indicates whether the beneficiary name was resolved. RESOLVED when receiver.accountName is present; UNAVAILABLE when lookup did not return a name.

transferType'ACH' | 'RTGS'

Example response

{
  "amount": 1047.1,
  "balance": 2000,
  "channelProvider": "AMANA BANK LIMITED",
  "fee": 47.1,
  "exchanged": true,
  "exchange": {
    "sourceCurrency": "USD",
    "targetCurrency": "TZS",
    "sourceAmount": 1000,
    "rate": 2500
  },
  "order": {
    "amount": 1000,
    "currency": "TZS",
    "id": "UNIQUEREFERENCE"
  },
  "payoutFeeBearer": "merchant",
  "receiver": {
    "accountNumber": "0112345400847jhs",
    "accountName": "TEMBO SHOP",
    "accountCurrency": "TZS",
    "amount": 1000
  }
}