Skip to main content

Simulating Disputes

Overview​

The simulateIssuer*CardPaymentDispute mutations are available in the Test environment only. They simulate the issuer's side of a dispute so you can drive a CardPaymentDispute through its lifecycle and exercise your webhook handling and response flow.

Error handling​

The mutation below returns a payload union of AccessDeniedError, UserError, and CardPaymentDispute. See API Error Handling for the general error-handling pattern.

Create a test dispute​

No API operation originates a CardPaymentDispute. Contact your Highnote representative to create a test dispute in the Test environment. Once the dispute exists, drive it with the mutation below.

Simulate issuer acceptance​

You can simulate the issuer accepting the full amount of the latest contested stage of the dispute by passing the dispute ID to simulateIssuerAcceptsFullCardPaymentDispute.

mutation SimulateIssuerAcceptsFullCardPaymentDispute(
  $input: SimulateIssuerAcceptsFullCardPaymentDisputeInput!
) {
  simulateIssuerAcceptsFullCardPaymentDispute(input: $input) {
    ... on CardPaymentDispute {
      id
      cardPaymentDisputeStatus
    }
    ... on UserError {
      errors {
        code
        description
      }
    }
    ... on AccessDeniedError {
      message
    }
  }
}
FieldTypeDescription
cardPaymentDisputeIdID!The CardPaymentDispute to drive to a full issuer acceptance.