Get information about an account's IBANs using the API

Get information about an account's IBANs with the API.

Guide

1. Call the account query.
2. Enter your account ID.
3. Add the information you need. This sample includes information relevant to IBANs, both main and virtual.
4. (Optional) Narrow the list of virtual IBANs with the filters argument on virtualIbanEntries: filter by status (Enabled, Suspended, or Canceled) or by entry ids.
5. Add pagination if you're expecting a long payload (line 6).

Query

Open in API Explorer

query GetAccountIbanInfo {
  account(accountId: "$YOUR_ACCOUNT_ID") {
    IBAN
    paymentAccountType
    paymentLevel
    virtualIbanEntries(first: 2) {
      edges {
        node {
          BIC
          IBAN
          id
          label
          status
        }
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
      }
      totalCount
    }
  }
}

Payload

There's a lot to learn from this payload response.

1. The account has a main IBAN (line 4), which means the paymentAccountType must be PaymentService (line 5). Main IBANs are issued when the account type changes from EMoney to PaymentService.
2. The paymentLevel is Unlimited, meaning virtual IBANs can be added to the account.
3. There are nine total virtual IBANs (line 32), and only two are listed in this response because of pagination.

{
  "data": {
    "account": {
      "IBAN": "$ACCOUNT_MAIN_IBAN",
      "paymentAccountType": "PaymentService",
      "paymentLevel": "Unlimited",
      "virtualIbanEntries": {
        "edges": [
          {
            "node": {
              "BIC": "SWNBFR22",
              "IBAN": "$VIRTUAL_IBAN_1",
              "id": "$VIRTUAL_IBAN_1_ID",
              "label": "Virtual",
              "status": "Enabled"
            }
          },
          {
            "node": {
              "BIC": "SWNBFR22",
              "IBAN": "$VIRTUAL_IBAN_2",
              "id": "$VIRTUAL_IBAN_2_ID",
              "label": "Virtual",
              "status": "Canceled"
            }
          }
        ],
        "pageInfo": {
          "hasNextPage": true,
          "hasPreviousPage": false
        },
        "totalCount": 9
      }
    }
  }
}