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
}
}
}
{
"refundPreviousPaymentInput": {
"acceptorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"paymentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"transactionReference": "example"
}
}
curl --request POST \
--url https://api.sandbox.com/graphql \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--data '{
"query": "mutation RefundPreviousPayment($refundPreviousPaymentInput: RefundPreviousPaymentInput!) {\n refundPreviousPayment(refundPreviousPaymentInput: $refundPreviousPaymentInput) {\n errors {\n ... on InternalServiceError {\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n transactionId\n }\n ... on RuleInViolationError {\n advice\n dateTimeUtc\n errorDateTime\n explanationOfRule\n message\n }\n ... on SyntaxOnNetworkResponseError {\n attemptedNetwork\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n }\n ... on TimeoutOnNetworkResponseError {\n attemptedNetwork\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n }\n ... on ValidationFailureError {\n dateTimeUtc\n errorDateTime\n fieldName\n fieldPath\n message\n }\n ... on PriorPaymentNotFoundError {\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n transactionId\n }\n }\n refundPreviousPaymentResponse {\n activityDate\n cardDetails {\n last4\n paymentBrand\n }\n duration\n isDuplicateRequest\n message\n networkResponseDetails {\n networkResponseCode\n processorResponseCode\n }\n paymentId\n paymentMethodResponse {\n\n }\n processorResponseCode\n sanitizedFields {\n fieldName\n fieldPath\n originalValue\n reason\n sanitizedValue\n }\n timestampUtc\n tokenDetails {\n token\n tokenizedPan\n }\n transactionId\n }\n }\n}",
"variables": {
"refundPreviousPaymentInput": {
"acceptorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"paymentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"transactionReference": "example"
}
}
}'
{
"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"
}
}
}
}
Transaction Processing
refundPreviousPayment
Refund a previously authorized payment using its payment ID and return a payload that includes details of the resulting transaction.
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
}
}
}
{
"refundPreviousPaymentInput": {
"acceptorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"paymentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"transactionReference": "example"
}
}
curl --request POST \
--url https://api.sandbox.com/graphql \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--data '{
"query": "mutation RefundPreviousPayment($refundPreviousPaymentInput: RefundPreviousPaymentInput!) {\n refundPreviousPayment(refundPreviousPaymentInput: $refundPreviousPaymentInput) {\n errors {\n ... on InternalServiceError {\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n transactionId\n }\n ... on RuleInViolationError {\n advice\n dateTimeUtc\n errorDateTime\n explanationOfRule\n message\n }\n ... on SyntaxOnNetworkResponseError {\n attemptedNetwork\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n }\n ... on TimeoutOnNetworkResponseError {\n attemptedNetwork\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n }\n ... on ValidationFailureError {\n dateTimeUtc\n errorDateTime\n fieldName\n fieldPath\n message\n }\n ... on PriorPaymentNotFoundError {\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n transactionId\n }\n }\n refundPreviousPaymentResponse {\n activityDate\n cardDetails {\n last4\n paymentBrand\n }\n duration\n isDuplicateRequest\n message\n networkResponseDetails {\n networkResponseCode\n processorResponseCode\n }\n paymentId\n paymentMethodResponse {\n\n }\n processorResponseCode\n sanitizedFields {\n fieldName\n fieldPath\n originalValue\n reason\n sanitizedValue\n }\n timestampUtc\n tokenDetails {\n token\n tokenizedPan\n }\n transactionId\n }\n }\n}",
"variables": {
"refundPreviousPaymentInput": {
"acceptorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"paymentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"transactionReference": "example"
}
}
}'
{
"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
Show child attributes
Show child attributes
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.
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
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
The unique ‘paymentId’ of the payment that is to be refunded.
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
Show child attributes
The base transaction amount intended to be collected by this payment not including any cashback, gratuity, fees, or taxes.Deprecated: Use subtotalAmount instead.
The cash back amount. Must be a non-negative value.
The purchasing currency code of the request amount.See TransactionAmountCurrencyCode
Total discount amount applied to the order. Must be a non-negative value.
Total charges for any import or export duties included in the order. Must be a non-negative value.
The gratuity amount. Must be a non-negative value.
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.
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.
Total shipping charges for the transaction. Must be a non-negative value.
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.
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.
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.
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!
Show Possible types
Show Possible types
Show InternalServiceError
Show InternalServiceError
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.Deprecated: Use errorDateTime instead.
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.
A human readable description of the error.
Tesouro response code indicating the error.See ProcessorResponseCode
Unique ID for the transaction assigned by Tesouro.
Show RuleInViolationError
Show RuleInViolationError
This occurs when an internal Tesouro business rule is in violation.
Advice on how to overcome the rule in the future.
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.Deprecated: Use errorDateTime instead.
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.
An explanation of why the rule exists.
A human readable description of the error.
Tesouro response code indicating the error.See ProcessorResponseCode
Unique ID for the transaction assigned by Tesouro.
Show SyntaxOnNetworkResponseError
Show SyntaxOnNetworkResponseError
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.Deprecated: Use errorDateTime instead.
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.
A human readable description of the error.
Tesouro response code indicating the error.See ProcessorResponseCode
Unique ID for the transaction assigned by Tesouro.
Show TimeoutOnNetworkResponseError
Show TimeoutOnNetworkResponseError
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.Deprecated: Use errorDateTime instead.
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.
A human readable description of the error.
Tesouro response code indicating the error.See ProcessorResponseCode
Unique ID for the transaction assigned by Tesouro.
The amount of time Tesouro waited for a response in milliseconds.
Show ValidationFailureError
Show ValidationFailureError
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.Deprecated: Use errorDateTime instead.
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.
The name of the graphql field in error.
The path to the graphql field in error.
A human readable description of the error.
Tesouro response code indicating the error.See ProcessorResponseCode
Unique ID for the transaction assigned by Tesouro.
The value of the graphql field in error.
Show PriorPaymentNotFoundError
Show PriorPaymentNotFoundError
This occurs when a prior referenced payment cannot be found
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.Deprecated: Use errorDateTime instead.
The date and time, in UTC, that the error occured. Formatted as 2024-03-27T02:40:00Z.
A human readable description of the error.
Tesouro response code indicating the error.See ProcessorResponseCode
Unique ID for the transaction assigned by Tesouro.
The payment id that cannot be found.
Show child attributes
Show child attributes
The date Tesouro received the transaction based on acceptor cutoff time
Details related to the card used on the transactionDeprecated: Use paymentMethodResponse instead.See CardInformation
Difference between request receipt and response in milliseconds.Deprecated: New durations coming soon.
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.
A detailed description of the response code. e.g., Insufficient funds.
The response code from the network.Deprecated: Use paymentMethodResponse instead.See NetworkResponseDetails
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.
Details related to the payment method used on the transaction
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Details associated with the token generated on a tokenization request.
Specifies which payment brand was used, e.g., Visa, MasterCard, Discover, American Express, etc.See PaymentBrand
Show child attributes
Show child attributes
Details associated with the token generated on a tokenization request.
Details related to the card used on the transaction
The response code from the network.
Specifies which payment brand was used, e.g., Visa, MasterCard, Discover, American Express, etc.See PaymentBrand
A normalized 4-character response code defined by Tesouro that represents the outcome of the payment transaction request.See ProcessorResponseCode
List of fields that were detected as invalid and sanitized by Tesouro to prevent the payment transaction request from failing.See SanitizedFieldOutput
The UTC date and time the transaction was received by Tesouro.
Details associated with the token generated on a tokenization request.See TokenDetails
A unique identifier created by Tesouro and assigned to the transaction.
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
}
}
}
{
"refundPreviousPaymentInput": {
"acceptorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"paymentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"transactionReference": "example"
}
}
curl --request POST \
--url https://api.sandbox.com/graphql \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
--data '{
"query": "mutation RefundPreviousPayment($refundPreviousPaymentInput: RefundPreviousPaymentInput!) {\n refundPreviousPayment(refundPreviousPaymentInput: $refundPreviousPaymentInput) {\n errors {\n ... on InternalServiceError {\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n transactionId\n }\n ... on RuleInViolationError {\n advice\n dateTimeUtc\n errorDateTime\n explanationOfRule\n message\n }\n ... on SyntaxOnNetworkResponseError {\n attemptedNetwork\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n }\n ... on TimeoutOnNetworkResponseError {\n attemptedNetwork\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n }\n ... on ValidationFailureError {\n dateTimeUtc\n errorDateTime\n fieldName\n fieldPath\n message\n }\n ... on PriorPaymentNotFoundError {\n dateTimeUtc\n errorDateTime\n message\n processorResponseCode\n transactionId\n }\n }\n refundPreviousPaymentResponse {\n activityDate\n cardDetails {\n last4\n paymentBrand\n }\n duration\n isDuplicateRequest\n message\n networkResponseDetails {\n networkResponseCode\n processorResponseCode\n }\n paymentId\n paymentMethodResponse {\n\n }\n processorResponseCode\n sanitizedFields {\n fieldName\n fieldPath\n originalValue\n reason\n sanitizedValue\n }\n timestampUtc\n tokenDetails {\n token\n tokenizedPan\n }\n transactionId\n }\n }\n}",
"variables": {
"refundPreviousPaymentInput": {
"acceptorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"paymentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"transactionReference": "example"
}
}
}'
{
"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"
}
}
}
}
Was this page helpful?
⌘I