Banks

Add Bank

This adds a validated NGN or GHS bank to your integration

post/payments/banks/add

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/banks/add/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring required

The bank ID from the Fetch Bank List endpoint.

accountNumberstring required

The bank account number to add.

currencystring

Optional. The bank account currency (ngn or ghs) should match the currency of the selected bank ID. If omitted, defaults to your business's operating country currency.

narrationstring

Optional narration that appears on the bank statement for withdrawals (max 32 characters).

Example request

{
  "id": "39",
  "accountNumber": "3154021148",
  "currency": "ngn",
  "narration": "Breet withdrawal"
}

Response

Bank added successfully

Changes

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