adjustBankAccountBalance

Requires permission payments:bank-account:update.

Moves a bank account's running balance by a signed amount with a reason: positive to add, negative to reduce. A zero adjustment is refused. This is the only way to change the balance outside a processed payment, and the change is audited. Requires permission to update bank accounts.

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

mutation AdjustBankAccountBalance($id: ID!, $input: AdjustBankAccountBalanceInput!) {
  adjustBankAccountBalance(id: $id, input: $input) {
    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": "mutation AdjustBankAccountBalance($id: ID!, $input: AdjustBankAccountBalanceInput!) {\n  adjustBankAccountBalance(id: $id, input: $input) {\n    id\n    accountNumber\n    branchCode\n    currencyCode\n    swiftCode\n    accountName\n  }\n}",
  "variables": {
    "id": "id",
    "input": {
      "delta": 0,
      "reason": "string"
    }
  }
}
EOF

Variables:

{
  "id": "id",
  "input": {
    "delta": 0,
    "reason": "string"
  }
}

Response:

{
  "data": {
    "adjustBankAccountBalance": {
      "id": "id",
      "accountNumber": "string",
      "branchCode": "string",
      "currencyCode": "string",
      "swiftCode": "string",
      "accountName": "string"
    }
  }
}

adjustBankAccountBalance(
  id: ID!
  input: AdjustBankAccountBalanceInput!
): BankAccount!

Arguments

adjustBankAccountBalance.id ● ID! non-null scalar

The ID of the bank account.

adjustBankAccountBalance.input ● AdjustBankAccountBalanceInput! non-null input

The signed amount and the reason for the adjustment.

Type

BankAccount object

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