revealBankAccountSecrets

Requires permission payments:bank-account:update.

Returns the full, unmasked account number and IBAN of one bank account. This is the only way to read them, it needs permission to update bank accounts, and every reveal is audited.

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 RevealBankAccountSecrets($id: ID!) {
  revealBankAccountSecrets(id: $id) {
    accountNumber
    iban
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query RevealBankAccountSecrets($id: ID!) {\n  revealBankAccountSecrets(id: $id) {\n    accountNumber\n    iban\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "revealBankAccountSecrets": {
      "accountNumber": "string",
      "iban": "string"
    }
  }
}

revealBankAccountSecrets(
  id: ID!
): BankAccountSecrets!

Arguments

revealBankAccountSecrets.id ● ID! non-null scalar

The ID of the bank account.

Type

BankAccountSecrets object

The unmasked account number and IBAN of a bank account. Returned only by revealBankAccountSecrets, which needs permission and is audited.