refundPreviousPayment

Refund a previously authorized payment using its payment ID and return a payload that includes details of the resulting transaction.

Operation

mutation RefundPreviousPayment($refundPreviousPaymentInput: RefundPreviousPaymentInput!) {
  refundPreviousPayment(refundPreviousPaymentInput: $refundPreviousPaymentInput) {
    errors {
      ... on InternalServiceError {
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
        transactionId
      }
      ... on RuleInViolationError {
        advice
        dateTimeUtc
        errorDateTime
        explanationOfRule
        message
      }
      ... on SyntaxOnNetworkResponseError {
        attemptedNetwork
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
      }
      ... on TimeoutOnNetworkResponseError {
        attemptedNetwork
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
      }
      ... on ValidationFailureError {
        dateTimeUtc
        errorDateTime
        fieldName
        fieldPath
        message
      }
      ... on PriorPaymentNotFoundError {
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
        transactionId
      }
    }
    refundPreviousPaymentResponse {
      activityDate
      cardDetails {
        last4
        paymentBrand
      }
      duration
      isDuplicateRequest
      message
      networkResponseDetails {
        networkResponseCode
        processorResponseCode
      }
      paymentId
      paymentMethodResponse {

      }
      processorResponseCode
      sanitizedFields {
        fieldName
        fieldPath
        originalValue
        reason
        sanitizedValue
      }
      timestampUtc
      tokenDetails {
        token
        tokenizedPan
      }
      transactionId
    }

}
}

Response

{
  "data": {
    "refundPreviousPayment": {
      "errors": [
        {
          "__typename": "InternalServiceError",
          "dateTimeUtc": "2026-01-15T14:30:00Z",
          "errorDateTime": "2026-01-15T14:30:00Z",
          "message": "example",
          "processorResponseCode": "A0000",
          "transactionId": "c9a1e2d3-4b5f-6789-0abc-def123456789"
        }
      ],
      "refundPreviousPaymentResponse": {
        "activityDate": "2026-01-15",
        "cardDetails": {
          "last4": "1234",
          "paymentBrand": "VISA"
        },
        "duration": 0,
        "isDuplicateRequest": true,
        "message": "example",
        "networkResponseDetails": {
          "networkResponseCode": "example",
          "processorResponseCode": "A0000"
        },
        "paymentId": "d8b2f3e4-5c6a-7890-1bcd-ef2345678901",
        "paymentMethodResponse": {
          "bankPaymentMethodDetails": "example",
          "cardPaymentMethodDetails": "example"
        },
        "processorResponseCode": "A0000",
        "sanitizedFields": [
          {
            "fieldName": "example",
            "fieldPath": "example",
            "originalValue": "example",
            "reason": "example",
            "sanitizedValue": "example"
          }
        ],
        "timestampUtc": "2026-01-15T14:30:00Z",
        "tokenDetails": {
          "token": "example",
          "tokenizedPan": "example"
        },
        "transactionId": "e7c3a4b5-6d7e-8901-2cde-f34567890123"
      }
    }
  }
}

Mutation

Arguments

refundPreviousPaymentInput · RefundPreviousPaymentInput! · required

Show child attributes

acceptorId · UUID! · required

A unique, 36 character identifier created by Tesouro and assigned to the entity providing the goods or services to the cardholder, such as a Merchant, a Submerchant of a Payment Facilitator, a Seller within a Marketplace, or a Biller of a Consumer Bill Payment Service Provider (CBPS). Historically, processors have called this identifier the Merchant ID (or MID), Outlet ID, or Customer number.

lineItems · [LineItemInput!]

Line item details for this order. If line items are provided on the refund any line items from the original authorization will be overridden. If line items are provided, transactionAmountDetails must be provided.

See LineItemInput

orderDetails · OrderDetailsInput

Details pertaining to the customer’s order. If null, order details from the original authorization will be used. If provided, all details from the original authorization will be overridden.

See OrderDetailsInput

paymentId · UUID! · required

The unique ‘paymentId’ of the payment that is to be refunded.

transactionAmountDetails · AmountDetailsInput

The partial or full amount of the transaction to be refunded. If you do not specify an amount, Tesouro will refund the full amount.

Show child attributes

baseAmount · DecimalAmount · deprecated

The base transaction amount intended to be collected by this payment not including any cashback, gratuity, fees, or taxes.

Deprecated: Use subtotalAmount instead.

cashBackAmount · DecimalAmount

The cash back amount. Must be a non-negative value.

currency · TransactionAmountCurrencyCode! · required

The purchasing currency code of the request amount.

See TransactionAmountCurrencyCode

discountAmount · Decimal

Total discount amount applied to the order. Must be a non-negative value.

dutyAmount · Decimal

Total charges for any import or export duties included in the order. Must be a non-negative value.

gratuityAmount · DecimalAmount

The gratuity amount. Must be a non-negative value.

localTaxAmount · Decimal

The total amount of local tax for this payment transaction request. Local tax is imposed by municipal, city, or regional governments and may include sales tax, service tax, or other location-based levies applicable to the transaction. Must be a non-negative value.

nationalTaxAmount · Decimal

The total amount of national tax for this payment transaction request. National tax is a government-imposed tax at the federal or country level, such as Goods and Services Tax (GST), or federal sales tax. Must be a non-negative value.

shippingAmount · Decimal

Total shipping charges for the transaction. Must be a non-negative value.

subtotalAmount · DecimalAmount

The sum of all item costs in the transaction before applying any additional charges such as taxes, or fees. Must be a non-negative value.

totalAmount · Decimal! · required

The requested amount intended to be collected by this transaction. A positive decimal with precision depending on transaction currency. For example: $10.00 would be 10.00 or 10.

totalTaxAmount · Decimal

The total amount of all taxes for this payment transaction request. Must be present if either local or national tax are present. Must be a non-negative value.

transactionReference · Max36Text! · required

A unique identifier created by the entity holding the direct relationship with the Acceptor, and used by that entity for reconciliation and transaction search. Tesouro uses this identifier to manage idempotency.

Return type

RefundPreviousPaymentPayload!

errors · [RefundPreviousPaymentError!]

Show Possible types

Show InternalServiceError

dateTimeUtc · DateTime! · required · deprecated

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

Deprecated: Use errorDateTime instead.

errorDateTime · DateTime! · required

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

message · String! · required

A human readable description of the error.

processorResponseCode · ProcessorResponseCode! · required

Tesouro response code indicating the error.

See ProcessorResponseCode

transactionId · UUID! · required

Unique ID for the transaction assigned by Tesouro.

Show RuleInViolationError

This occurs when an internal Tesouro business rule is in violation.

advice · String! · required

Advice on how to overcome the rule in the future.

dateTimeUtc · DateTime! · required · deprecated

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

Deprecated: Use errorDateTime instead.

errorDateTime · DateTime! · required

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

explanationOfRule · String! · required

An explanation of why the rule exists.

message · String! · required

A human readable description of the error.

processorResponseCode · ProcessorResponseCode! · required

Tesouro response code indicating the error.

See ProcessorResponseCode

ruleName · RuleName! · required

The name of the rule in violation

See RuleName

transactionId · UUID! · required

Unique ID for the transaction assigned by Tesouro.

Show SyntaxOnNetworkResponseError

attemptedNetwork · Network! · required

The network the transaction request was attempted with.

See Network

dateTimeUtc · DateTime! · required · deprecated

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

Deprecated: Use errorDateTime instead.

errorDateTime · DateTime! · required

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

message · String! · required

A human readable description of the error.

processorResponseCode · ProcessorResponseCode! · required

Tesouro response code indicating the error.

See ProcessorResponseCode

transactionId · UUID! · required

Unique ID for the transaction assigned by Tesouro.

Show TimeoutOnNetworkResponseError

attemptedNetwork · Network! · required

The network the authorization was attempted.

See Network

dateTimeUtc · DateTime! · required · deprecated

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

Deprecated: Use errorDateTime instead.

errorDateTime · DateTime! · required

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

message · String! · required

A human readable description of the error.

processorResponseCode · ProcessorResponseCode! · required

Tesouro response code indicating the error.

See ProcessorResponseCode

transactionId · UUID! · required

Unique ID for the transaction assigned by Tesouro.

waitTime · Int! · required

The amount of time Tesouro waited for a response in milliseconds.

Show ValidationFailureError

dateTimeUtc · DateTime! · required · deprecated

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

Deprecated: Use errorDateTime instead.

errorDateTime · DateTime! · required

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

fieldName · String! · required

The name of the graphql field in error.

fieldPath · String! · required

The path to the graphql field in error.

message · String! · required

A human readable description of the error.

processorResponseCode · ProcessorResponseCode! · required

Tesouro response code indicating the error.

See ProcessorResponseCode

transactionId · UUID! · required

Unique ID for the transaction assigned by Tesouro.

valueInError · String! · required

The value of the graphql field in error.

Show PriorPaymentNotFoundError

This occurs when a prior referenced payment cannot be found

dateTimeUtc · DateTime! · required · deprecated

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

Deprecated: Use errorDateTime instead.

errorDateTime · DateTime! · required

The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.

message · String! · required

A human readable description of the error.

processorResponseCode · ProcessorResponseCode! · required

Tesouro response code indicating the error.

See ProcessorResponseCode

transactionId · UUID! · required

Unique ID for the transaction assigned by Tesouro.

unknownPaymentId · UUID! · required

The payment id that cannot be found.

refundPreviousPaymentResponse · RefundPreviousPaymentResponse

Show child attributes

activityDate · Date! · required

The date Tesouro received the transaction based on acceptor cutoff time

cardDetails · CardInformation · deprecated

Details related to the card used on the transaction

Deprecated: Use paymentMethodResponse instead.

See CardInformation

duration · Int! · required · deprecated

Difference between request receipt and response in milliseconds.

Deprecated: New durations coming soon.

isDuplicateRequest · Boolean! · required

Result of Tesouro’s idempotency check. If the transaction reference matches that of another transaction from that presenter it will be treated as a duplicate.

message · String! · required

A detailed description of the response code. e.g., Insufficient funds.

networkResponseDetails · NetworkResponseDetails! · required · deprecated

The response code from the network.

Deprecated: Use paymentMethodResponse instead.

See NetworkResponseDetails

paymentId · UUID! · required

A unique 36 character identifier created by Tesouro and assigned to a group of transactions in the same payment request cohort. e.g., An authorization request, incremental authorization request, and the final capture would have the same paymentID.

paymentMethodResponse · PaymentMethodResponse! · required

Details related to the payment method used on the transaction

Show child attributes

bankPaymentMethodDetails · BankPaymentMethodDetailsResponse

Show child attributes

acquirerTokenDetails · AcquirerTokenDetails! · required

Details associated with the token generated on a tokenization request.

paymentBrand · PaymentBrand! · required

Specifies which payment brand was used, e.g., Visa, MasterCard, Discover, American Express, etc.

See PaymentBrand

cardPaymentMethodDetails · CardPaymentMethodDetailsResponse

Show child attributes

acquirerTokenDetails · AcquirerTokenDetails! · required

Details associated with the token generated on a tokenization request.

cardDetails · CardInformation! · required

Details related to the card used on the transaction

networkResponseDetails · NetworkResponseDetails! · required

The response code from the network.

paymentBrand · PaymentBrand! · required

Specifies which payment brand was used, e.g., Visa, MasterCard, Discover, American Express, etc.

See PaymentBrand

processorResponseCode · ProcessorResponseCode! · required

A normalized 4-character response code defined by Tesouro that represents the outcome of the payment transaction request.

See ProcessorResponseCode

sanitizedFields · [SanitizedFieldOutput!]! · required

List of fields that were detected as invalid and sanitized by Tesouro to prevent the payment transaction request from failing.

See SanitizedFieldOutput

timestampUtc · DateTime! · required

The UTC date and time the transaction was received by Tesouro.

tokenDetails · TokenDetails

Details associated with the token generated on a tokenization request.

See TokenDetails

transactionId · UUID! · required

A unique identifier created by Tesouro and assigned to the transaction.

Operation

mutation RefundPreviousPayment($refundPreviousPaymentInput: RefundPreviousPaymentInput!) {
  refundPreviousPayment(refundPreviousPaymentInput: $refundPreviousPaymentInput) {
    errors {
      ... on InternalServiceError {
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
        transactionId
      }
      ... on RuleInViolationError {
        advice
        dateTimeUtc
        errorDateTime
        explanationOfRule
        message
      }
      ... on SyntaxOnNetworkResponseError {
        attemptedNetwork
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
      }
      ... on TimeoutOnNetworkResponseError {
        attemptedNetwork
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
      }
      ... on ValidationFailureError {
        dateTimeUtc
        errorDateTime
        fieldName
        fieldPath
        message
      }
      ... on PriorPaymentNotFoundError {
        dateTimeUtc
        errorDateTime
        message
        processorResponseCode
        transactionId
      }
    }
    refundPreviousPaymentResponse {
      activityDate
      cardDetails {
        last4
        paymentBrand
      }
      duration
      isDuplicateRequest
      message
      networkResponseDetails {
        networkResponseCode
        processorResponseCode
      }
      paymentId
      paymentMethodResponse {

      }
      processorResponseCode
      sanitizedFields {
        fieldName
        fieldPath
        originalValue
        reason
        sanitizedValue
      }
      timestampUtc
      tokenDetails {
        token
        tokenizedPan
      }
      transactionId
    }

}
}

Response

{
  "data": {
    "refundPreviousPayment": {
      "errors": [
        {
          "__typename": "InternalServiceError",
          "dateTimeUtc": "2026-01-15T14:30:00Z",
          "errorDateTime": "2026-01-15T14:30:00Z",
          "message": "example",
          "processorResponseCode": "A0000",
          "transactionId": "c9a1e2d3-4b5f-6789-0abc-def123456789"
        }
      ],
      "refundPreviousPaymentResponse": {
        "activityDate": "2026-01-15",
        "cardDetails": {
          "last4": "1234",
          "paymentBrand": "VISA"
        },
        "duration": 0,
        "isDuplicateRequest": true,
        "message": "example",
        "networkResponseDetails": {
          "networkResponseCode": "example",
          "processorResponseCode": "A0000"
        },
        "paymentId": "d8b2f3e4-5c6a-7890-1bcd-ef2345678901",
        "paymentMethodResponse": {
          "bankPaymentMethodDetails": "example",
          "cardPaymentMethodDetails": "example"
        },
        "processorResponseCode": "A0000",
        "sanitizedFields": [
          {
            "fieldName": "example",
            "fieldPath": "example",
            "originalValue": "example",
            "reason": "example",
            "sanitizedValue": "example"
          }
        ],
        "timestampUtc": "2026-01-15T14:30:00Z",
        "tokenDetails": {
          "token": "example",
          "tokenizedPan": "example"
        },
        "transactionId": "e7c3a4b5-6d7e-8901-2cde-f34567890123"
      }
    }
  }
}