On This Page
Refund a Payment
You can refund a completed payment for the full amount or a partial amount by sending a refund request. Oney supports multiple
refund requests when the total amount of all of the refund requests is less than the captured amount.
Requesting a refund requires the request ID from the capture response. The request ID is
located in the
ID
response field.Endpoints
Production:
POST
https://api.cybersource.com
/pts/v2/payments/{id}
/refundsTest:
POST
https://apitest.cybersource.com
/pts/v2/payments/{id}
/refundsThe is the request ID
contained in the original transaction request.
{id}
Response Statuses
Cybersource
responds to your refund request with one of these statuses as the status
field value:- FAILED: The refund request failed.
- REFUNDED: The refund request is accepted but is not completed. Request the check status service to retrieve status updates. For more information, see Check a Transaction Status.
When you send a check status request to retrieve an updated refund status, these are
the possible responses:
- FAILED: The refund request failed.
- REFUNDED: The captured payment is successfully refunded.
Required Fields for Refunding a Payment
- Set toONEY.
- Set toBNPL.
- Set toAP_REFUND.
Example: Issuing a Refund
Request
{ "clientReferenceInformation": { "code": "refnum-1234" }, "paymentInformation": { "paymentType": { "name": "BNPL", "method": { "name": "ONEY" } } }, "processingInformation": { "actionList": "AP_REFUND" }, "orderInformation": { "amountDetails": { "totalAmount": "5.00", "currency": "EUR" } } }
Response
{ "_links": { "self": { "method": "GET", "href": "/pts/v2/refunds/7546768549536451204805" }, "status": { "method": "POST", "href": "/pts/v2/refresh-payment-status/7546768549536451204805" } }, "clientReferenceInformation": { "code": "refnum-1234", "returnReconciliationId": "W0N56E1YK06T" }, "id": "7546768549536451204805", "orderInformation": { "amountDetails": { "currency": "EUR" } }, "processorInformation": { "responseDetails": "00006", "transactionId": "430844862998", "responseCode": "00006" }, "reconciliationId": "XFZ3ZE1G1DID", "refundAmountDetails": { "refundAmount": "5.00" }, "status": "REFUNDED", "submitTimeUtc": "2025-08-08T18:14:18Z" }