Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Merchant Bank Accounts

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

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

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

Path parameters

idstring uuid required

The unique identifier of the merchant

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

The unique identifier of the merchant

Query parameters

currencystring

Optional currency code (ISO 4217) to filter active accounts

Example:GBP

Optional currency code (ISO 4217) to filter active accounts

Filter by account role(s). Defaults to settlement if not specified.

[
  "settlement"
]
include_balanceboolean

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

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"
    }
  ]
}