Skip to main content
POST
/
payouts
/
preview-bank-payout
cURL
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payouts/preview-bank-payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "accountNumber": "<string>",
  "orderReference": "<string>",
  "bic": "<string>",
  "accountCurrency": "TZS",
  "checksum": "<string>"
}
'
{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

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

application/json
​
amount
number
required
​
accountNumber
string
required
​
currency
enum<string>
required

Account currency to pay out from (TZS or USD)

Available options:
TZS,
USD
​
orderReference
string
required

Your unique Order reference

​
bic
string
required

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

​
transferType
enum<string>
required
Available options:
ACH,
RTGS
​
accountCurrency
enum<string>
default:TZS

Receiving currency for the payout (TZS)

Available options:
TZS
​
checksum
string

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

Response

Bank payout preview response

​
amount
number

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

Example:

1047.1

​
balance
number
Example:

2000

​
channelProvider
string
Example:

"AMANA BANK LIMITED"

​
fee
number

Transaction fee deducted from source currency (included in amount)

Example:

47.1

​
exchanged
boolean

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

Example:

true

​
exchange
object

Exchange rate details (only present when exchanged is true)

​
order
object
​
payoutFeeBearer
enum<string>
Available options:
merchant,
both,
customer
Example:

"merchant"

​
nameLookupStatus
enum<string>

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

Available options:
RESOLVED,
UNAVAILABLE
​
receiver
object
​
transferType
enum<string>
Available options:
ACH,
RTGS