Skip to main content

Payment Approval (VAN)

This API requests payment approval using the Auth Sequence Number (certControlNo) received from the payment window.

Critical Implementation Guidelines
  • Network Error/Timeout: If you do not receive a response due to a timeout or network error, you MUST check the status via Query Transaction Status, retrieve the transaction ID, and proceed with a cancellation.
  • Amount Mismatch: If the approved amount in the response differs from the merchant's requested amount, you MUST cancel the transaction immediately.
  • DB Update Failure: If your internal database fails to process the result after a successful approval, you MUST cancel the transaction to maintain data integrity.

Request​

Request URL
POST https://{API Domain}/appcardpay/v1/approval.do
Content-type: application/json; charset=euc-kr
Note

Supports API Idempotency (See API Idempotency)

Caution

The final approval process may take time; please set your client timeout to 30 seconds.

Parameters​

Field NameTypeLengthRequiredDescription
vanTidString8Byte✅VAN Terminal ID
shopTransactionIdString60Byte✅Merchant Transaction ID (API Idempotency Key)
certControlNoString40Byte✅Auth Sequence Number (Use the value received from the auth window as-is)
approvalReqDateString8Byte✅Approval Request Date (yyyyMMdd)
Request Example
{  
"vanTid": "{VAN Terminal ID}",
"shopTransactionId": "{API Idempotency Key}",
"certControlNo": "{Auth Sequence Number}",
"approvalReqDate": "{yyyyMMdd}"
}

Response​

Parameters​

Field NameTypeLengthRequiredDescription
resCdString4Byte✅Result Code (Success: “0000”)
resMsgString1000Byte✅Result Message
shopTransactionIdString60Byte✅Returns the value sent in the approval request
vanTidString8ByteVAN Terminal ID
shopOrderNoString40ByteMerchant Order Number (Matches registration value)
controlNoString20ByteKICC Transaction Sequence Number
amountNumberTotal Payment Amount
transactionDateString14ByteTransaction Date (yyyyMMddHHmmss)
accepterIdString15ByteMember Store ID
paymentInfoObjectPayment Approval Result Details (See paymentInfo below)

paymentInfo (Approval Result Details)​

Field NameTypeLengthRequiredDescription
payMethodTypeString2Byte✅Payment Method Code (Credit Card: "11")
vanSerialString20ByteVAN Transaction Serial Number
authNoString20Byte✅Approval Number
cardInfoObjectCredit Card Payment Result (See cardInfo below)

paymentInfo > cardInfo (Credit Card Result)​

Field NameTypeLengthRequiredDescription
cardNoString20Byte✅Card Number (Masked *)
issuerCodeString3Byte✅Issuer Code (See Card Codes)
acquirerCodeString3Byte✅Acquirer Code (See Card Codes)
installmentMonthString2Byte✅Installment Months
employeeCardTypeString1ByteEmployee card code (provided only when exists)
Response Example
{
"resCd": "0000",
"resMsg": "Payment Success",
"vanTid": "{VAN Terminal ID}",
"controlNo": "{KICC Transaction Sequence Number}",
"shopTransactionId": "{API Idempotency Key}",
"shopOrderNo": "{Merchant Order Number}",
"amount": 51004,
"transactionDate": "20210326090200",
"accepterId": "{Member Store ID}",
"paymentInfo": {
"payMethodType": "11",
"authNo": "00017177",
"vanSerial": "50123011010326090200",
"cardInfo": {
"cardNo": "45184211******81",
"issuerCode": "029",
"acquirerCode": "029",
"installmentMonth": "00"
}
}
}