bankAccounts

Requires at least one of the permissions payments:bank-account:list, payments:bank-account:read, payments:collection:create, payments:payment:create or purchase:payment:create.

Lists the organization's bank accounts, with the account number masked. Filter by active status, account type, currency or search text. Needs the bank accounts read or list permission, or a permission to record a collection or a payment into one.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BankAccounts {
  bankAccounts {
    id
    accountNumber
    branchCode
    currencyCode
    swiftCode
    accountName
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BankAccounts {\n  bankAccounts {\n    id\n    accountNumber\n    branchCode\n    currencyCode\n    swiftCode\n    accountName\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bankAccounts": [
      {
        "id": "id",
        "accountNumber": "string",
        "branchCode": "string",
        "currencyCode": "string",
        "swiftCode": "string",
        "accountName": "string"
      }
    ]
  }
}

bankAccounts(
  filter: BankAccountFilter
): [BankAccount!]!

Arguments

bankAccounts.filter ● BankAccountFilter input

Optional filters: active status, account type, currency and search text.

Type

BankAccount object

A bank account the organization receives money into or pays from, in one currency.