> ## Documentation Index > Fetch the complete documentation index at: https://docs.breet.io/llms.txt > Use this file to discover all available pages before exploring further. # Add Bank > This adds a validated NGN or GHS bank to your integration ## OpenAPI ````yaml /api-reference/openapi.json post /payments/banks/add openapi: 3.0.0 info: title: BREET PUBLIC API version: 1.0.0 license: name: Proprietary url: https://breet.io/terms servers: - url: https://api.breet.io/v1 security: - appId: [] appSecret: [] breetEnv: [] tags: - name: Crypto Wallet description: Generate and manage crypto wallet addresses for receiving deposits. x-group: Wallets and Deposits - name: Withdrawals description: >- ## Withdrawals To help protect your funds, withdrawals support an additional security layer through **IP whitelisting**. ### IP Whitelisting When IP whitelisting is enabled, all withdrawal requests must originate from an approved IP address. Any withdrawal request coming from an IP not on the whitelist will be automatically blocked. You can add up to **7 IP addresses** from your dashboard. This feature is recommended for: - Production servers - Preventing unauthorized withdrawal attempts ### How it works - Enable IP whitelisting from your dashboard - Add up to 7 trusted IP addresses - Only requests from those IPs will be allowed to initiate withdrawals If IP whitelisting is disabled, withdrawals can be initiated from any IP address. - name: Banks description: List, validate, add, and remove bank accounts for fiat withdrawals. - name: Transactions description: Retrieve deposit and trade transaction history. - name: Webhooks description: >- Inspect and retry **outgoing** webhooks we send to your server (trade and withdrawal events). Requires an active integration with API access (VIP partners). For **incoming** payload shapes and verification, see the Webhooks guide in the Guides tab. - name: Assets description: >- Retrieve the list of supported deposit/sell assets and their configuration. - name: Rates and Prices description: >- Get live market prices and calculate conversion rates. These endpoints are public and do not require authentication. - name: Account description: Retrieve and update integration account details and preferences. - name: Testing description: Endpoints for testing your integration in development. - name: Conversion description: >- Convert between USD and local fiat (NGN | GHS). Available for both user and integration (business) flows. - name: Wallet addresses description: >- Add and remove withdrawal (payout) wallet addresses. If the same address, network, and token are sent with a different label, the existing address is updated. paths: /payments/banks/add: post: tags: - Banks summary: Add Bank description: This adds a validated NGN or GHS bank to your integration operationId: addBank requestBody: content: application/json: schema: type: object required: - id - accountNumber properties: id: type: string description: The bank ID from the Fetch Bank List endpoint. example: '39' accountNumber: type: string description: The bank account number to add. example: '3154021148' currency: type: string description: >- 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. example: ngn narration: type: string description: >- Optional narration that appears on the bank statement for withdrawals (max 32 characters). example: Breet withdrawal responses: '200': description: Bank added successfully content: application/json: example: message: bank added success: true data: id: 69737920df8b52679a8b198e account: 69547e78ab637caab7d7839c user: 68ca0d24604d65932aac2fc8 accountName: CHIROMA AHMED OLABANJI accountNumber: '3154021148' autoSettlement: false bankId: '39' bankName: United Bank For Africa createdAt: '2026-01-23T13:35:27.948Z' currency: ngn disabled: false integration: 692d994b7ca6e4da422363fb isBusiness: true narration: Breet withdrawal type: nuban updatedAt: '2026-01-23T13:35:27.948Z' meta: {} summary: {} stats: {} '400': description: Bank cannot be added content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: alreadyExists: summary: Bank account already on file value: success: false message: account already exists. meta: {} errors: [] data: {} maxBanks: summary: Maximum bank limit reached value: success: false message: you cannot add more than 3 banks meta: {} errors: [] data: {} needsVerification: summary: Bank verification is required first value: success: false message: you have to verify your bank to add a bank meta: {} errors: [] data: {} '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/ValidationError' '500': $ref: '#/components/responses/InternalServerError' components: schemas: ErrorResponse: type: object required: - success - message properties: success: type: boolean enum: - false message: type: string meta: type: object errors: type: array items: type: object data: type: object responses: Unauthorized: description: Invalid or missing API credentials content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: notAuthenticated: summary: Missing credentials value: success: false message: you're not authenticated meta: {} errors: [] data: {} wrongCredentials: summary: Invalid app ID or secret value: success: false message: wrong app id and secret combination meta: {} errors: [] data: {} ValidationError: description: >- Request validation failed — check the errors array for field-level details content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false message: validation errors meta: {} errors: - message: Invalid value field: amount location: body data: {} InternalServerError: description: An unexpected server error occurred content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false message: something went wrong! meta: {} errors: [] data: {} securitySchemes: appId: type: apiKey in: header name: x-app-id description: Your application ID from the Breet dashboard appSecret: type: apiKey in: header name: x-app-secret description: Your application secret from the Breet dashboard breetEnv: type: apiKey in: header name: X-Breet-Env description: 'Environment selector: development or production' ````