createRefund

MUTATION

Deprecated: Use createReversal instead.

This call will create a refund 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

Boolean

Examples

Refund a settled charge

Creates a deprecated refund for a settled charge.

SUCCESS 200

GRAPHQL

mutation CreateRefund(
  $transaction_id: String!
  $amount: Int!
  $refund_reason: RefundReasonInput!
) {
  createRefund(
    transaction_id: $transaction_id
    amount: $amount
    refund_reason: $refund_reason
  )
}