Refunds

A refund is a follow-on request that uses the request ID from the initiate sale response. The request ID links the refund to the initiate sale.

Refund Restrictions

Multiple partial refunds are allowed. Partial refunds are not allowed for mobile billing payments or escrow payments. Partial refunds are not allowed when a green tax was present in the initiate sale request using the orderInformation.amountDetails.taxDetails[].type field. Refunds using the API service are not allowed for escrow payments.

When using the orderInformation.amountDetails.taxDetails[].type field, the types of refunds you can request are determined by the field's value:

Endpoints

The {id} is the request ID contained in the original transaction request.

Example

{  "clientReferenceInformation": {    "code": "refnum-1234"  },  "paymentInformation": {    "paymentType": {      "name": "LOCALCARD",      "method": {        "name": "KCP"      }    }  },  "processingInformation": {    "actionList": "AP_REFUND"  },  "orderInformation": {    "amountDetails": {      "totalAmount": "10",      "currency": "KRW"    }  }}

{    "_links": {        "self": {            "method": "GET",            "href": "/pts/v2/refunds/7202083841056082403955"        },        "status": {            "method": "POST",            "href": "/pts/v2/refresh-payment-status/7202083841056082403955"        }    },    "clientReferenceInformation": {        "code": "refnum-1234"    },    "id": "7202083841056082403955",    "orderInformation": {        "amountDetails": {            "currency": "KRW"        }    },    "processorInformation": {        "responseDetails": "0000",        "transactionId": "20130530123456"    },    "refundAmountDetails": {        "refundAmount": "10"    },    "submitTimeUtc": "2024-07-05T19:39:44Z"}

Response Codes and Statuses

After sending an API request, sends you a response message that includes a reason code in the HTTP response. Reason codes can be added at any time.

Refund Test Information

In the test environment, you can simulate the specific error messages that you receive from transaction requests by using test triggers. Test triggers are request field values that can generate specific responses in the response messages. The simulated environment enables you to become familiar with the response messages and develop methods for error handling.

To simulate a test, set the clientReferenceInformation.reconciliationId field to a value listed in the Trigger Value column.