Refunds

This section provides the information you need in order to process a
refund
, which is linked to a capture or sale.
You must request a
refund
 within 180 days of the authorization.
When your account is enabled for credit authorizations, also known as purchase return authorizations,
Cybersource
 authenticates the card and customer during a
refund or
credit request. Every credit request is automatically authorized.
Credit authorization results are returned in these response fields:
  • processorInformation.approvalCode
  • processorInformation.networkTransactionId
  • processorInformation.responseCode
When you request a void for the credit and the credit is voided. If your account is enabled for credit authorizations, the credit authorization is also reversed.

Endpoint

Production:
POST
https://api.cybersource.com
/pts/v2/payments/
{id}
/refunds
Test:
POST
https://apitest.cybersource.com
/pts/v2/payments/
{id}
/refunds
The
{id}
 is the transaction ID returned in the capture or sale response.

Required Fields for Processing a
Refund

REST Interactive Example: Processing a Refund

Refund a Payment

REST Example: Processing a Refund

Light Dark
Request
123456
{"orderInformation": {
        "amountDetails": {
            "totalAmount": "100.00",
            "currency": "EUR"
        }
    }}
Response to a Successful Request
1234567891011121314151617181920212223242526272829303132333435363738394041424344
{"_links": {
        "void": {
            "method": "POST",
            "href": "/pts/v2/credits/6699964581696622603955/voids"
        },
        "self": {
            "method": "GET",
            "href": "/pts/v2/credits/6699964581696622603955"
        }
    },
    "clientReferenceInformation": {
        "code": "1669996458298"
    },
    "creditAmountDetails": {
        "currency": "eur",
        "creditAmount": "100.00"
    },
    "id": "6699964581696622603955",
    "orderInformation": {
        "amountDetails": {
            "currency": "EUR"
        }
    },
    "paymentAccountInformation": {
        "card": {
            "type": "001"
        }
    },
    "paymentInformation": {
        "tokenizedCard": {
            "type": "001"
        },
        "card": {
            "type": "001"
        }
    },
    "processorInformation": {
        "approvalCode": "888888",
        "networkTransactionId": "016153570198200",
        "responseCode": "100"
    },
    "reconciliationId": "61873329OAILG3Q6",
    "status": "PENDING",
    "submitTimeUtc": "2022-12-02T15:54:18Z"}
Light Dark
Request
123456789101112
{"clientReferenceInformation": {
    "code": "CNP-FOR-1"
  },
  "orderInformation": {
    "billTo": {
      "firstName": "first"
    },
    "amountDetails": {
      "totalAmount": "0.23",
      "currency": "AUD"
    }
  }}
Response to a Successful Request
1234567891011121314151617181920212223242526272829303132333435
{"_links": {
    "void": {
      "method": "POST",
      "href": "/pts/v2/refunds/7204282190676807103
093/voids"
    },
    "self": {
      "method": "GET",
      "href": "/pts/v2/refunds/7204282190676807103
093"
    }
  },
  "clientReferenceInformation": {
    "code": "CNP-FOR-1"
  },
  "id": "7204282190676807103093",
  "orderInformation": {
    "amountDetails": {
      "currency": "AUD"
    }
  },
  "processorInformation": {
    "systemTraceAuditNumber": "468221",
    "retrievalReferenceNumber": "468221433908",
    "seblementDate": "0708",
    "responseCode": "00"
  },
  "reconciliationId": "7204282190676807103093",
  "refundAmountDetails": {
    "currency": "AUD",
    "refundAmount": "0.23"
  },
  "status": "PENDING",
  "submitTimeUtc": "2024-07-
08T08:43:39Z"}