Skip to main content

Payment Approval

This API requests the final payment approval using the information such as tokens obtained during the simple payment authentication stage.

Critical Implementation Guidelines
  • Network Error/Timeout: If you do not receive a response due to a Read Timeout or Network Error, the transaction might have actually been approved. In such cases, you MUST call the Net-Cancel API to ensure data consistency.
  • Amount Mismatch: If the approved amount in the response differs from the merchant's requested amount, you MUST initiate a cancellation.
  • Internal Process Failure: If your internal database fails to process the result after a successful approval, you MUST cancel the transaction.

Request​

Request URL
POST https://{API Domain}/smpy/kiccpay/reqAprv
Content-type: application/json; charset=utf-8
Caution

The final approval process may take time. Please set your client's network timeout to 30 seconds.

Parameters​

Field NameTypeLengthRequiredDescription
tidString10Byte✅KICC Terminal ID
svcIdString10Byte✅KICC Simple Payment Service ID
bizrNoString10Byte✅Merchant Business Registration Number
mercTrxNoString40Byte✅Merchant Transaction Number (20Byte recommended)
tokenKeyString128Byte✅Token data received after authentication. Must encrypt the authorizationId (received in the auth response) using AES256.
alotMonthString2Byte✅Installment Period (Default: "00" - Lump-sum)
trxAmtNumber✅Total Payment Amount
vatAmtNumber✅VAT (Can be omitted if the total amount includes VAT)
svcAmtNumberService Charge
taxFreeAmtNumberTax-free Amount
tranDtString8Byte✅Merchant Transmission Date (yyyyMMdd)
tranTmString6Byte✅Merchant Transmission Time (HH24MISS)
userDataString512ByteMerchant Custom Data (Echo field)
Request Example
{
"tid": "T123456789",
"svcId": "SVC_SIMPLE",
"bizrNo": "1234567890",
"mercTrxNo": "ORD_20231225_0001",
"tokenKey": "TOKEN_ABC123XYZ...",
"alotMonth": "00",
"trxAmt": 10000,
"vatAmt": 909,
"svcAmt": 0,
"taxFreeAmt": 0,
"tranDt": "20231225",
"tranTm": "120000",
"userData": "User_001"
}

Response​

Parameters​

Field NameTypeLengthRequiredDescription
respCdString4Byte✅Result Code (Success: “0000”)
respMsgString128Byte✅Result Message
tidString10Byte✅KICC Terminal ID sent in request
svcIdString10Byte✅Service ID sent in request
bizrNoString10Byte✅Merchant Business Registration Number
mercTrxNoString20Byte✅Merchant Transaction Number
trxDtString8Byte✅VAN Processing Request Date
trxTmString6Byte✅VAN Processing Request Time
issFmCdString4Byte✅Issuer Code (Refer to Card Codes)
issFmNmString20Byte✅Issuer Name
purchFmCdString4Byte✅Acquirer Code (Refer to Card Codes)
purchFmNmString20Byte✅Acquirer Name
joShopNoString15Byte✅Card Issuer Merchant Number
aprvDtString8Byte✅Card Issuer Approval Date (yyyyMMdd)
aprvTmString6Byte✅Card Issuer Approval Time (HH24MISS)
aprvNoString10Byte✅Credit Approval Number
vanTrxNoString12Byte✅VAN Unique Transaction Number
cardConfirmNoString40Byte✅Masked Card Number
Response Example
{
"respCd": "0000",
"respMsg": "Approval Success",
"tid": "T123456789",
"svcId": "SVC_SIMPLE",
"bizrNo": "1234567890",
"mercTrxNo": "ORD_20231225_0001",
"trxDt": "20231225",
"trxTm": "120001",
"issFmCd": "06",
"issFmNm": "KB Kookmin Card",
"purchFmCd": "06",
"purchFmNm": "KB Kookmin Card",
"joShopNo": "1234567890",
"aprvDt": "20231225",
"aprvTm": "120002",
"aprvNo": "12345678",
"vanTrxNo": "V12345678901",
"cardConfirmNo": "1234-56**-****-1234"
}