Withdrawals

Withdrawal (NGN | GHS)

Initiate fiat (NGN | GHS) payout to bank

post/payments/withdraw/bank/{id}

Request

Base URL
https://api.breet.io/v1
Auth
API key in header x-app-id and API key in header x-app-secret and API key in header X-Breet-Env
TypeScript
https://skmtc.dev/breet/apis/breet-public-api/docs/payments/withdraw/bank/:id/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

ID of the saved bank account to withdraw to.

amountnumber required

Withdrawal amount in NGN or GHS, depending on the recipient's bank account currency.

pinstring

PIN set on your dashboard.

narrationstring

Optional note that appears on the bank statement. Maximum 32 characters.

externalIdstring

Your unique reference for this withdrawal. Can be used to retrieve the withdrawal later.

Bank withdrawal initiated successfully

No recorded changes to this operation across all 3 revisions of this API.