> ## Documentation Index
> Fetch the complete documentation index at: https://readme.amana-dev.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add bank for withdrawal

> Save a bank account to the user's profile for withdrawals.

## Body

Content type: `application/json`

<ParamField body="bankName" type="string" required />

<ParamField body="bankAddress" type="string" required />

<ParamField body="accountName" type="string" required />

<ParamField body="swiftCode" type="string" required />

<ParamField body="iban" type="string" required />

<ParamField body="fname" type="string" />

<ParamField body="lname" type="string" />

<ParamField body="address" type="string" />

<ParamField body="accountCurrency" type="string" />

<ParamField body="country" type="string" />

<ParamField body="defaultForEntity" type="boolean" required default="false" />

## Response

`200` Success.

<ResponseField name="success" type="boolean" />

<ResponseField name="verification" type="boolean" />

## Possible Errors

| Error | Possible cause | What to do |
| - | - | - |
| 400 | Invalid or missing field, amount outside limits | Check the request against the schema and the instrument's size limits. |
| 401 | Token missing or expired | Log in again or use the refresh token. |
| 403 | IP not whitelisted, or account restricted | Confirm your IP is whitelisted; otherwise contact Amana. |
| 409 / 422 | Market closed, insufficient balance or margin | Check trading hours and balance, then retry. |
| 429 / 5xx | Rate limit, or temporary issue on our side | Retry with backoff; contact support if it persists. |

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url 'https://gateway.amana.io/payments/client/add-crm-bank' \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
    "bankName": "<string>",
    "bankAddress": "<string>",
    "accountName": "<string>",
    "swiftCode": "<string>",
    "iban": "<string>",
    "fname": "<string>",
    "lname": "<string>",
    "address": "<string>",
    "accountCurrency": "<string>",
    "country": "<string>",
    "defaultForEntity": false
  }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://gateway.amana.io/payments/client/add-crm-bank"
  headers = {"Authorization": "Bearer <token>", "Content-Type": "application/json"}
  payload = {
      "bankName": "<string>",
      "bankAddress": "<string>",
      "accountName": "<string>",
      "swiftCode": "<string>",
      "iban": "<string>",
      "fname": "<string>",
      "lname": "<string>",
      "address": "<string>",
      "accountCurrency": "<string>",
      "country": "<string>",
      "defaultForEntity": false
  }

  response = requests.request("POST", url, json=payload, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://gateway.amana.io/payments/client/add-crm-bank', {
    method: 'POST',
    headers: {"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    body: JSON.stringify({"bankName": "<string>", "bankAddress": "<string>", "accountName": "<string>", "swiftCode": "<string>", "iban": "<string>", "fname": "<string>", "lname": "<string>", "address": "<string>", "accountCurrency": "<string>", "country": "<string>", "defaultForEntity": false}),
  });
  console.log(await response.json());
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "success": true,
    "verification": true
  }
  ```

  ```json 400 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 401 theme={null}
  {
    "error": "<string>",
    "message": "<string>",
    "details": {}
  }
  ```

  ```json 403 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 409 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 422 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 429 theme={null}
  {
    "error": "<string>",
    "message": "<string>"
  }
  ```

  ```json 500 theme={null}
  {
    "error": "<string>",
    "message": "<string>",
    "details": {}
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.