GET api/payments/refunds/{refundPaymentId}
Gets a refund to make on the card terminal. Responses: 200 with the refund, or 200 with null if no refund has this ID.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| refundPaymentId |
The RefundPaymentId from the CNPRefund message. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
The refund, or null.
PaymentRefundDT| Name | Description | Type | Additional information |
|---|---|---|---|
| Url | string |
None. |
|
| RefundPaymentId | globally unique identifier |
None. |
|
| OriginalPaymentId | globally unique identifier |
None. |
|
| Processed | boolean |
None. |
|
| ProcessedDateTimeStamp | date |
None. |
|
| IsSaved | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"url": "sample string 1",
"refundPaymentId": "86385f04-29e6-426a-9c47-d74aef2e9278",
"originalPaymentId": "8c208e68-31c5-4d1e-a237-c5e7ac629df8",
"processed": true,
"processedDateTimeStamp": "2026-11-04T14:41:38.9865236+00:00",
"isSaved": true
}