Preview Bank Payout
Validates a bank payout and returns the fee, balance, and estimated arrival.
nameLookupStatus (RESOLVED or UNAVAILABLE). If UNAVAILABLE, receiver.accountName is omitted — pass your own verified name on Create Bank Payout.404 with the message: No balance account is linked to this merchant yet. Balance becomes available after the first successful payment or deposit.Authorizations
Authorization header containing the JWT access token returned from the generate token endpoint. The token already includes the Bearer prefix. Example: Authorization: Bearer eyJhbGciOi...
Body
Account currency to pay out from (TZS or USD)
TZS, USD Your unique Order reference
Beneficiary bank BIC. You can fetch the list of bank BICs from the banks list endpoint.
Receiving currency for the payout (TZS)
TZS Optional. Accepted for existing integrations. ClickPesa selects the settlement rail — use the response transferType.
ACH, RTGS If enabled, this is the generated checksum of the payload. Refer to the documentation for more details.
Response
Bank payout preview response
Total amount to be deducted from your account balance (includes fee)
1047.1
2000
"AMANA BANK LIMITED"
Transaction fee deducted from source currency (included in amount)
47.1
Indicates if currency conversion was applied (true when source currency differs from receiving currency)
true
Exchange rate details (only present when exchanged is true)
merchant, both, customer "merchant"
Indicates whether the beneficiary name was resolved. RESOLVED when receiver.accountName is present; UNAVAILABLE when lookup did not return a name.
RESOLVED, UNAVAILABLE Settlement applied to this payout.
ACH, RTGS, GTB "ACH"
Expected time for funds to arrive.
Instant, 1-3 Working Days "Instant"

