API change history provides you with API-related changes.

2021.05.19

Online payments

Remove the following documentations to the corresponding product documentations:

• Settlement Items
• Settlement Summary
• Transaction Items

In-store payments

Remove the following documentations to the corresponding product documentations:

• Settlement Items
• Settlement Summary
• Transaction Items

2021.04.09

Online payments

• New field and enum(appId and MINI_APP) are added to the following APIs:

• pay (Cashier Payment)
• pay (Auto Debit)
• consult

2021.03.08

Online payments

Delete the following fields in the Settlement Summary file:

• transactionAmountValue
• transactionCurrency

In-store payments

• Delete the following fields in the Settlement Summary file:

• transactionAmountValue
• transactionCurrency

• Delete INVALID_CODE of error codes in the following APIs:

• pay (User-presented Mode Payment)
• pay (Order Code Payment)
• pay (Entry Code Payment)

• Add INVALID_PAYMENT_CODE of error codes in pay (User-presented Mode Payment).

2021.02.26

Online payments

Add the following new APIs in online payments:

• registration
• notifyRegistrationStatus
• inquiryRegistrationStatus
• inquiryRegistrationInfo

In-store payments

Add the following new APIs in in-store payments:

• registration
• notifyRegistrationStatus
• inquiryRegistrationStatus
• inquiryRegistrationInfo

2020.08.20

Online payments

• For the notifyPayment interface, the result code PROCESS_FAIL, REQUEST_TRAFFIC_EXCEED_LIMIT, and PARAM_ILLEGAL are removed.
• For the applyToken interface, the result code USER_NOT_EXIST and USER_STATUS_ABNORMAL are added.

In-store payments

• For the notifyPayment interface, the result code PROCESS_FAIL, REQUEST_TRAFFIC_EXCEED_LIMIT, and PARAM_ILLEGAL are removed.

2020.07.30

Online payments

• For the Settlement Items file, descriptions of the transactionId, originalTransactionId, and originalTransactionRequestId fields are updated for adding the auth/capture scenario.
• For the Transaction Items file, descriptions of the transactionId, originalTransactionId, and originalTransactionRequestId fields are updated for adding the auth/capture scenario.

2020.06.09

Online payments

• For the applyToken interface, the note about the extend field is deleted.
• For the Settlement Items, Settlement Summary, and Transaction Items files, the file name for the case that no transaction exists is updated.
• Add the following error codes for the pay interface:

• USER_NOT_EXIST
• NO_PAY_OPTION
• PAYMENT_NOT_EXIST
• ORDER_NOT_EXIST
• ORDER_IS_CLOSED

• Add the following error code for the notifyPayment interface:

• ORDER_IS_CLOSED

• Add the creditPayPlan field to the following interfaces:

• pay (Cashier Payment)
• pay (Auto Debit Payment)

In-store payments

• The following change is made to the notifyPayment:

For a payment process with a failed or unknown status, no notification is to be returned to the merchant.

• The following change is made to the pay (User-presented Mode Payment) interface:

Additional instructions for the order field are provided.

• Add the following error codes for the pay interface:

• USER_NOT_EXIST
• NO_PAY_OPTION
• PAYMENT_NOT_EXIST
• ORDER_NOT_EXIST
• ORDER_IS_CLOSED

• Add the following error code for the notifyPayment interface:

• ORDER_IS_CLOSED

2020.04.30

Online payments

The settlementStrategy field is added to the following interface:

• pay (Cashier Payment)
• pay (Auto Debit Payment)

The originalTransactionRequestId is added to the following files:

• Settlement Items
• Transaction Items

In-store payments

The originalTransactionRequestId is added to the following files:

• Settlement Items
• Transaction Items

2020.04.17

Online payments & In-store payments

The actualPaymentAmount and paymentQuote fields are removed from the following interfaces:

• pay (Cashier Payment)
• pay (Agreement Payment)
• pay (User-presented Mode Payment)
• pay (Order Code Payment)
• pay (Entry Code Payment)
• notifyPayment
• inquiryPayment

In-store payments

Description of the paymentExpiryTime field is modified for the following interfaces:

• pay (Order Code Payment)
• pay (Entry Code Payment)

2020.03.20

Online payments

The Authorization Inquiry interface is removed.

2020.03.12

Online payments

The following result codes were removed from the notifyPayment interface:

• KEY_NOT_FOUND
• ACCESS_DENIED
• API_INVALID
• CLIENT_INVALID
• METHOD_NOT_SUPPORTED
• MEDIA_TYPE_NOT_ACCEPTABLE

The following changes were made to the Settlement Items file name, Settlement Summary file name, and Transaction Items file name:

• settlementItems_<settlementCurrency>_<settlementBatchId>_<seq>.csv, was updated to settlementItems_<pspName>_<settlementCurrency>_<settlementBatchId>_<seq>.csv.
• settlementSummary_<settlementCurrency>_<settlementBatchId>_<seq>.csv, was updated to settlementSummary_<pspName>_<settlementCurrency>_<settlementBatchId>_<seq>.csv.
• transactionItems_<transactionCurrency>_<seq>.csv, was updated to transactionItems_<pspName>_<transactionCurrency>_<transactionDate>_<seq>.csv.

In-store payments

The following result codes were removed from the notifyPayment interface:

• KEY_NOT_FOUND
• ACCESS_DENIED
• API_INVALID
• CLIENT_INVALID
• METHOD_NOT_SUPPORTED
• MEDIA_TYPE_NOT_ACCEPTABLE

2020.03.03

Online payments

The following parameters were removed from the pay, notifyPayment, inquiryPayment, and refund interfaces:

• totalSettlementAmount
• settlementQuote

In-store payments

The following parameter was updated for the pay, notifyPayment, inquiryPayment, and refund interfaces:

• totalSettlementAmount was modified to grossSettlementAmount

2020.02.25

Online payments & In-store payments

The following parameters were added to the response of pay, inquiryPayment, and refund interfaces:

• totalSettlementAmount
• settlementQuote

The following parameters were added to the request of notifyPayment interface:

• totalSettlementAmount
• settlementQuote

The following parameters were added to the request of inquiryPayment interface:

• paymentResultCode
• paymentResultMessage
• transaction

2020.02.06

Online payments & In-store payments

The following changes were made to the request of Settlement Items, Settlement Summary, and Transaction Items:

• partnerId: modified to customerId
• extendInfo: removed

2020.02.04

Online payments & In-store payments

The following changes were made to the request of pay interface:

• merchant: removed
• env: removed
• order: its sub fields were updated in the following ways:

• Added the merchant field
• Added the env field

2020.01.20

In-store payments

The Entry Code Payment is added to in-store payments.

2020.01.15

Online payments & In-store payments

The following changes were made to the request of pay interface:

• paymentVerificationData:  the length of this field is changed to /
• merchant: added a note to state that the sub-field merchant.merchantName must be required for in-store payments

2019.12.30

Online payments & In-store payments

The following changes were made to the request of pay interface:

• merchant: added 
• env: added
• order: its sub fields were updated in the following ways:

• Removed the merchant field
• Removed the env field

2019.12.25

In-store payments

The following change was made to the request of pay interface:

• paymentNotifyUrl: updated to mandatory

2019.12.20

Online payments & In-store payments

The extendInfo field is removed from all the following interfaces:

• pay (Cashier Payment)
• pay (User-presented Mode Payment)
• pay (Order Code Payment)
• notifyPayment
• inquiryPayment
• cancel
• refund
• consult
• applyToken
• revoke
• Authorization Inquiry

2019.11.14

Online payments & In-store payments

The following change was made to Data Dictionary:

• For DisplayType, the value IMAGE was updated to MIDDLEIMAGE.

2019.11.12

Online payments & In-store payments

1. For the following interfaces, the result code INVALID_API is modified to API_INVALID and the result code INVALID_CLIENT is modified to CLIENT_INVALID:

• pay (Cashier Payment)
• pay (User-presented Mode Payment)
• pay (Order Code Payment)
• notifyPayment
• inquiryPayment
• cancel
• refund
• consult
• applyToken
• revoke
• Authorization Inquiry

2. The following changes were made to the response of pay interface:

• paymentActionForm: removed
• challengeActionForm: added
• redirectActionForm: added
• orderCodeForm: added

3. The following change was made to the request of pay interface:

• order.referenceOrderId: updated to optional

4. The following change was made to the request of notifyPayment interface:

• paymentCodeForm: removed

5. The following change was made to the response of inquiryPayment interface:

• paymentActionForm: removed
• redirectActionForm: added

2019.11.06

Online payments & In-store payments

For the following interfaces, the result code INVALID_SIGNATURE is modified to SIGNATURE_INVALID:

• pay (Cashier Payment)
• pay (User-presented Mode Payment)
• pay (Order Code Payment)
• notifyPayment
• inquiryPayment
• cancel
• refund
• consult
• applyToken
• revoke
• Authorization Inquiry

2019.10.24

Online payments & In-store payments

1. The following changes were made to the request of pay interface:

• payToAmount: removed
• paymentQuote: removed
• paymentAmount: its description is updated and is updated to mandatory
• paymentFactor: its sub-fields are updated

2. The following changes were made to the response of pay interface:

• payToAmount: removed
• paymentQuote: its description is updated
• paymentAmount: its description is updated and this field is updated to mandatory
• actualPaymentAmount: added
• nonGuaranteeCouponValue: removed

3. The following changes were made to the request of notifyPayment interface:

• payToAmount: removed
• paymentQuote: its description is updated
• paymentAmount: its description is updated and this field is updated to mandatory
• actualPaymentAmount: added
• nonGuaranteeCouponValue: removed

4. The following changes were made to the response of inquiryPayment interface:

• paymentAmount: its description is updated and this field is updated to mandatory
• payToAmount: removed
• actualPaymentAmount: added
• paymentQuote: its description is updated
• nonGuaranteeCouponValue: removed

5. The following change was made to the request of cancel interface:

• paymentRequestId: added

6. The following change was made to the request of refund interface:

• refundStrategyType: removed
• asyncRefund: removed
• isAsyncRefund: added
• extendInfo: the length is updated to 512