POST
/
payouts
/
create-bank-payout
cURL
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payouts/create-bank-payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "accountNumber": "<string>",
  "accountName": "<string>",
  "currency": "TZS",
  "accountCurrency": "TZS",
  "exchange": {
    "fromCurrency": "USD",
    "toCurrency": "USD",
    "rate": 123,
    "amount": 123
  },
  "orderReference": "<string>",
  "bic": "<string>",
  "transferType": "ACH",
  "checksum": "<string>"
}'
{
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "orderReference": "<string>",
  "amount": "202360.00",
  "currency": "TZS",
  "fee": "2360.00",
  "exchanged": true,
  "exchange": {
    "sourceCurrency": "USD",
    "targetCurrency": "TZS",
    "sourceAmount": 1000,
    "rate": 2500
  },
  "status": "AUTHORIZED",
  "channel": "BANK TRANSFER",
  "channelProvider": "Equity Bank Tanzania Limited",
  "transferType": "ACH",
  "order": {
    "amount": "20000.00",
    "currency": "TZS"
  },
  "beneficiary": {
    "accountNumber": "123456789",
    "accountName": "John Doe",
    "amount": "20000.00"
  },
  "clientId": "<string>"
}

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
​
accountName
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
​
exchange
object

Exchange rate information for currency conversion (required when payout currency differs from Account currency)

​
checksum
string

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

Response

Create bank payout response

​
updatedAt
string<date-time>
​
createdAt
string<date-time>
​
id
string
​
orderReference
string
​
amount
string

Total amount deducted from your account balance (includes fee)

Example:

"202360.00"

​
currency
string
Example:

"TZS"

​
fee
string

Transaction fee deducted from source currency (included in amount)

Example:

"2360.00"

​
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)

​
status
enum<string>
Available options:
AUTHORIZED,
SUCCESS,
REVERSED
​
channel
enum<string>
Available options:
BANK TRANSFER
​
channelProvider
string
Example:

"Equity Bank Tanzania Limited"

​
transferType
enum<string> | null
Available options:
ACH,
RTGS
Example:

"ACH"

​
order
object
​
beneficiary
object
​
clientId
string

Application Client ID associated with the payout