Skip to content

Create a payout to a bank or mobile-money account

POST
/payouts
curl --request POST \
--url https://api.bizzle.my/v1/payouts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "amount": 1, "currency": "TZS", "method": { "type": "mobile_money", "network": "example", "msisdn": "example", "bank_code": "example", "account_number": "example" }, "description": "example", "metadata": {} }'
Idempotency-Key
string
<= 255 characters

Unique identifier used to replay requests safely.

Media typeapplication/json
object
amount
required
integer
>= 1
currency
string
default: TZS
method
required
object
type
string
Allowed values: mobile_money bank
network
string
msisdn
string
bank_code
string
account_number
string
description
string
metadata
object

Payout created.

Error response.

Media typeapplication/json
object
error
required
string
message
string
code
string
details
object

Example generated

{
"error": "example",
"message": "example",
"code": "example",
"details": {}
}

Too many requests.

Media typeapplication/json
object
error
required
string
message
string
code
string
details
object

Example generated

{
"error": "example",
"message": "example",
"code": "example",
"details": {}
}
RateLimit-Limit
integer

Maximum requests per window.

RateLimit-Remaining
integer

Requests remaining in the current window.

RateLimit-Reset
integer

Unix seconds when the window resets.

Retry-After
integer

Seconds to wait before retrying (on 429/handled outages).