createReversal

MUTATION

This call will create a refund or a void for a transaction.

Arguments

transaction_idRequired

String

The Pay Theory unique identifier for the transaction to refund.

amountRequired

Int

The amount of the refund. This must be less than or equal to the amount of the transaction.

refund_reasonRequired

RefundReasonInput

The reason for the refund. This is required for all refunds and is made up of the following.

refund_email

String

The email address to send the refund receipt to. If not provided an email will not be sent out.

Response

ReversalResponse

is_void

Boolean

Whether void.

transaction_id

String| null

Full void: no new transaction ID handed back. Partial void: new transaction ID for the adjusted debit. Refund: transaction ID points to the reversal.

Examples

Full void

Voids the full unsettled transaction. No new transaction ID is handed back.

SUCCESS 200

GRAPHQL

mutation CreateReversal(
  $transaction_id: String!
  $amount: Int!
  $refund_reason: RefundReasonInput!
) {
  createReversal(
    transaction_id: $transaction_id
    amount: $amount
    refund_reason: $refund_reason
  ) {
    is_void
    transaction_id
  }
}