BAbanqzinc
Merchant Bank Accounts

Get active bank account(s) for a merchant. Optionally filter by currency query param.

Changed on

Get active bank account(s) for a merchant. Optionally filter by currency query param.

get/api/v1/merchants/{id}/bank-accounts/active

Request

Path parameters

idstring uuid required

The unique identifier of the merchant

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

currencystring

Optional currency code (ISO 4217) to filter active accounts

Example:GBP
[
  "settlement"
]
include_balanceboolean

Include balance for accounts that support it (requires additional API calls)

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "account_number": "11223344",
      "currency": "GBP",
      "country": "GB",
      "created_at": "2024-03-19T12:00:00Z",
      "updated_at": "2024-03-19T12:00:00Z",
      "iban": "DE89370400440532013000",
      "bic": "MARKDEF1100",
      "sort_code": "123456",
      "routing_number": "123456789",
      "bban": "86011117947",
      "plusgiro_number": "41054685",
      "bsb": "062-000",
      "account_holder_name": "John Smith",
      "supported_payment_schemes": [
        {
          "name": "SEPA Credit Transfer"
        }
      ],
      "roles": [
        "receiving",
        "settlement"
      ],
      "balance": "1234.56"
    }
  ]
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      for the query request parameter currency, the minLength was increased from 0 to 3

    • breaking

      added the pattern ^[A-Za-z]{3}$ to the query request parameter currency

    • breaking

      the / response's property type changed from string to no type for status

    • warning

      for the query request parameter currency, the maxLength was set to 3

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter include_balance

    • info

      added the new optional query request parameter roles

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      added subschema #6 subschema #7 to the //// response property anyOf list for the response status

    • info

      the // response's property pattern ^[A-Za-z]{2}$ was added for the status

    • info

      the // response's property pattern ^[A-Za-z]{3}$ was added for the status

  • 6637b341d86dRevision changes
    • info

      endpoint added