Check Payment Status
This API is used to verify the payment status if you do not receive a payment completion notification within a certain timeframe.
Critical Integrity Checks
- Amount Mismatch: If the payment amount in the approval result differs from your requested amount, you MUST cancel the transaction immediately.
- DB Update Failure: If you fail to update your internal database after receiving a successful approval result, you MUST cancel the transaction.
Request
Request URL
POST https://{API Domain}/api/trades/alipay/find
Content-type: application/json; charset=utf-8
Note
Supports API Idempotency (See API Idempotency)
Caution
Since retrieving the final status from the global network may take time, you must set the timeout to 30 seconds.
Parameters
| Field Name | Type | Length | Required | Description |
|---|---|---|---|---|
| mallId | String | 8Byte | ✅ | Merchant ID assigned by KICC |
| shopTransactionId | String | 60Byte | ✅ | Merchant Transaction ID (API Idempotency Key) |
| pgCno | String | 60Byte | ✅ | PG Transaction ID (Received in Transaction Creation Response) |
Request Example
{
"mallId": "{Merchant ID}",
"shopTransactionId": "{API Idempotency Key}",
"pgCno": "{PG Transaction ID}"
}
Response
Parameters
| Field Name | Type | Length | Required | Description |
|---|---|---|---|---|
| resCd | String | 4Byte | ✅ | Response Code |
| resMsg | String | 1000Byte | ✅ | Response Message |
| shopTransactionId | String | 60Byte | ✅ | Returns the value sent in the request |
| mallId | String | 8Byte | Merchant ID assigned by KICC | |
| approvalDate | String | 14Byte | Alipay Approval Date/Time (yyyyMMddHHmmss) | |
| statusCd | String | 4Byte | Transaction Status Approved: “TS01” Full Cancel: “TS02” Partial Cancel: “TS06” Network Cancel (Void): “TS12” | |
| walletBrandName | String | 20Byte | Name of the Alipay wallet actually used by the customer | |
| amountInfo | Object | Payment Amount Info (See amountInfo below) | ||
| exchangeCurrencyInfo | Object | Exchange Rate Info (See exchangeCurrencyInfo below) |
amountInfo (Payment Amount Info)
| Field Name | Type | Length | Required | Description |
|---|---|---|---|---|
| currency | String | 2Byte | ✅ | Currency Code |
| totAmount | Number | ✅ | Total Payment Amount |
exchangeCurrencyInfo (Exchange Rate Info)
| Field Name | Type | Length | Required | Description |
|---|---|---|---|---|
| baseCurrency | String | 3Byte | Base Currency Code | |
| exchangeCurrency | String | 3Byte | Exchange Currency Code | |
| exchangeCurrencyRate | String | 16Byte | Base Exchange Rate |
Response Example
{
"resCd": "0000",
"resMsg": "Success",
"shopTransactionId": "{API Idempotency Key}",
"mallId": "{Merchant ID}",
"approvalDate": "20230312000512",
"statusCd": "TS01",
"walletBrandName": "CONNECT_WALLET",
"amountInfo": {
"currency": "KRW",
"totAmount": 1000
}
}