customerBankAccounts

Requires a customer (portal or buyer app) session.

Seller bank accounts the buyer can pay an EFT into: active and in the order's currency (the org currency when orderId is omitted). Exactly one entry has isDefault = true (the seller's default account) — preselect it. Empty when the seller has none.

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 CustomerBankAccounts {
  customerBankAccounts {
    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 CustomerBankAccounts {\n  customerBankAccounts {\n    id\n    accountNumber\n    branchCode\n    currencyCode\n    swiftCode\n    accountName\n  }\n}"
}
EOF

Response:

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

customerBankAccounts(
  orderId: ID
): [CustomerBankAccountOption!]!

Arguments

customerBankAccounts.orderId ● ID scalar

The order the accounts are for, so they match its currency. Omit for the organization currency.

Type

CustomerBankAccountOption object

One of the seller's bank accounts a buyer may pay an EFT into (active, in the order's currency). — always read from the org's bank accounts.