Void Credit Grant

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

VoidCreditGrantInput

required

Input for voiding a credit grant

Show properties

UUID

required

Credit grant ID to void

UUID

Environment ID

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.

Create Credit Grant - Grant credits
Credit Grants - List grants

Create Credit Grant Archive Credit Type

⌘I

Overview

SDKs

Queries

Mutations

Types

Void Credit Grant

Mutation

Parameters

Return Type

​Mutation

​Parameters

​Return Type

​Related Operations

Mutation

Parameters

Return Type

Related Operations