Skip to main content
Voids an existing credit grant, removing the associated credits from the customer’s balance.

​
Mutation

mutation VoidCreditGrant($input: VoidCreditGrantInput!) {
  voidCreditGrant(input: $input) {
    id
    status
  }
}

{
  "input": {
    "creditGrantId": "grant-123"
  }
}

{
  "data": {
    "voidCreditGrant": {
      "id": "grant-123",
      "status": "VOID"
    }
  }
}

​
Parameters

​
input
VoidCreditGrantInput
required
Input for voiding a credit grant
Overdraft credit grants cannot be voided via the API. They are automatically voided when fully settled by a new credit grant. Attempting to void an overdraft grant will return an error: "Overdraft credit grants cannot be voided".

​
Return Type

Returns the voided CreditGrant with updated status.