POST
/
payouts
/
create-bank-payout-request
curl --request POST \
  --url https://api.clickpesa.com/third-parties/payouts/create-bank-payout-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "accountNumber": "<string>",
  "accountName": "<string>",
  "currency": "TZS",
  "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": "20000.00",
  "currency": "TZS",
  "fee": "2360.00",
  "status": "AUTHORIZED",
  "channel": "BANK TRANSFER",
  "channelProvider": "Equity Bank Tanzania Limited",
  "settlementType": "ACH",
  "beneficiary": {
    "accountNumber": "123456789",
    "accountName": "John Doe"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
amount
number
required
​
accountNumber
string
required
​
accountName
string
required
​
currency
enum<string>
required
Available options:
TZS
​
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
​
checksum
string

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

Response

200
application/json
USSD Push Preview response
​
updatedAt
string
​
createdAt
string
​
id
string
​
orderReference
string
​
amount
string
Example:

"20000.00"

​
currency
string
Example:

"TZS"

​
fee
string
Example:

"2360.00"

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

"Equity Bank Tanzania Limited"

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

"ACH"

​
beneficiary
object