On This Page
FILTER BY TAG

Refund a Payment

Send a refund request to credit a
SETTLED
 capture. A refund request requires the request ID and reconciliation ID returned in the capture response.

Endpoints

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 request ID contained in the original transaction request.

Response Status

Cybersource
 responds to your request with one of these statuses in the
status
.
  • FAILED
    : The refund request failed.
  • PENDING
    : The refund request is accepted but is not refunded. Request the check status service to retrieve status updates.
  • REFUNDED
    : The captured payment is successfully refunded.

REST API
 Example: Refunding a Payment

Request
{
  "clientReferenceInformation": {
    "code": "refnum-1234"
  },
  "paymentInformation": {
    "paymentType": {
      "name": "INVOICE",
      "method": {
        "name": "AFTERPAY"
      }
    }
  },
  "processingInformation": {
    "actionList": "AP_AUTH_REVERSAL"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "1.00",
      "currency": "USD"
    }
  }
}
Response to a Successful Request
{
  "clientReferenceInformation": {
    "code": "refnum-1234",
    "returnReconciliationId": "EE3FLQ9GXCWH"
  },
  "id": "6246062044236748603086",
  "reconciliationId": "XFZOSQ97H6UE",
  "orderInformation": {
    "amountDetails": {
      "totalAmount": "1.00"
    }
  },
  "submitTimeUtc": "2024-10-19T17:45:24Z",
  "status": "PENDING",
  "processorInformation": {
    "responseCode": "00006",
    "transactionId": "47797f6a-d894-428b-91d2-",
    "responseDetails": "00006"
  },
  "_links": {
    "self": {
      "href": "/pts/v2/payments/6246062044236748603086",
      "method": "GET"
    },
    "checkStatus": {
      "href": "/pts/v2/refresh-payment-status/6246062044236748603086",
      "method": "POST"
    }
  }
}
RELATED TO THIS PAGE