API Documentation
  1. API Reference Guide
API Documentation
  • API Reference Guide
    • Checkout Page
    • Payin - KRW (Server to Server)
    • Purpose Code
    • Payout Payload Example
    • List of Payin Methods
    • List of Bank for Payout Methods
  • API Documentation
    • Master Data
      • Get All Country & Currency Code
    • Payout Method
      • Get All Payout Method
    • Payin Method
      • Get All Payin Method
      • Get Required Fields by Payin method
    • Payin
      • Create Payin
      • Simulate Payin
      • Retrieve Payin
      • Create Virtual Account
    • Payout
      • Create Payout
      • Simulate Payout
      • Retrieve Payout
      • Get All Payout
    • Checkout
      • Create Payment Request
      • Get All Checkout
      • Get Detail Checkout
      • Create Virtual Account [KRW]
      • Get VA Bank Information [KRW]
      • Create New Checkout
    • Transaction
      • Find Transaction by Id
      • Get All Transaction
    • Wallet
      • Create Wallet
      • Get All Wallet
      • Get by Wallet Id
    • Customer
      • Create Customer
      • Update Customer
      • Get All Customer
      • Get Detail Customer by Id
      • Check Is Customer Wallet Ready
      • Enable Customer
      • Disable Customer
      • Delete Customer
    • Webhook
      • Webhook PAYIN SUCCESS
      • Webhook PAYOUT SUCCESS
      • Webhook PAYOUT FAILED
      • VA Register Callback
    • Merchant
      • Get Balance
    • Get List Payment Method by Currency
      GET
  • Features Documentation
    • Dashboard
    • Transaction
      • Payin
      • Payout
      • Rolling Reserve
      • Refund Request
    • Finance
      • Settlement Report APM
      • Settlement Report CARD
      • History Balance APM
      • History Balance CARD
    • Account
      • Profile Account
      • Manage Users
    • Setting
      • Integration Details
  1. API Reference Guide

Checkout Page

Checkout generates a secure payment page that functions seamlessly across devices and facilitates payment process with several payment method options.

Checkout Flow#

1
Create Payment Request
In this request you can fill in information such as amount, currency, country_code, country_name. In addition, merchant also has to complete other mandatory information according to the specified format in order to submit the request. Further information about API details is on the following link
Create Payment Request
2
Payment Request Success
Once the payment request is successful, the merchant will get a response message containing important information such as transaction id, checkout_token, and checkout_url.
3
Checkout Page
You can use checkout_url that contains the checkout_token to display the checkout page. The checkout page will display information such as Payment Amount, Payment Methods, Order Items, and Checkout Page expiration time according to the information sent in the Payment Request step.
image.png
Checkout Page
4
Payment Details
When the customer has selected the payment method, a payment field will be displayed and must be filled in by the customer to complete the payment step. The fields displayed will be adjusted to the selected payment method whether it is a Credit/Debit Card or VA.
Credit/Debit Card
Virtual Account
5
Redirection Url
After checkout, the customer will be automatically redirected to the redirection url according to the checkout status. The checkout status includes Completed, Failed, Cancelled and Expired. Merchant can set the redirect url in the Create Payment API request message in the Advanced_redirect_url field.
6
Webhook
Merchant will get payment status information through the webhook that we have provided below.
Webhook

Alternative Checkout Flow#

If you want to use the checkout page by submitting a specific payin method, you can follow the flow below:
1
Create Payment Request
In this request you can fill in information such as amount, currency, country_code, country_name. In addition, merchant also has to complete other mandatory information according to the specified format in order to submit the request. Further information about API details is on the following link
Create Payment Request
2
Payment Request Success
Once the payment request is successful, the merchant will get a response message containing important information such as transaction id, checkout_token.You need to save the checkout_token, and you can initially ignore the checkout_url.
3
Get List Checkout Payment Method
Once the payment request is successful.You can retrieve the payment method data that supports the currency and merchant using the following API. The API response will show a list of payment methods that can be used at checkout. You can choose one of the available payment_method_payin values and use it in the next step.
Get List Payment Method by Currency
4
Create New Checkout
Merchants can continue the checkout process using the following Create New Checkout API. You can enter the checkout_token obtained from the response of the create payment request API, and enter the payin_method_name that will be used in the checkout process.
Create New Checkout
5
Checkout Page
You can use checkout_url that contains the checkout_token in the Create New Checkout API Response to display the checkout page. The checkout page will display information such as Payment Amount, Payment Methods, Order Items, and Checkout Page expiration time according to the information sent in the Previous step.
In this step a payment information will also be displayed based on the Create New Checkout input. The fields displayed will be adjusted to the selected payment method whether it is a Credit/Debit Card, VA, or QR.
Virtual Account
6
Redirection Url
After checkout, the customer will be automatically redirected to the redirection url according to the checkout status. The checkout status includes Completed, Failed, Cancelled and Expired. Merchant can set the redirect url in the Create Payment API request message in the Advanced_redirect_url field.
7
Webhook
Merchant will get payment status information through the webhook that we have provided below.
Webhook

Alternative Checkout Flow (KRW)#

If you want to use the checkout page by submitting a specific payin method using KRW Currency, you can follow the flow below:
1
Create Payment Request
In this request you can fill in information such as amount, currency, country_code, country_name, and account_number. In addition, merchant also has to complete other mandatory information according to the specified format in order to submit the request. Further information about API details is on the following link
Create Payment Request
2
Payment Request Success
Once the payment request is successful, the merchant will get a response message containing important information such as transaction id, checkout_token.You need to save the checkout_token.
3
Get List Checkout Payment Method
Once the payment request is successful.You can retrieve the payment method data that supports the currency and merchant using the following API. The API response will show a list of payment methods that can be used at checkout. You can choose one of the available payment_method_payin values and use it in the next step.
Get List Payment Method by Currency
4
Create Virtual Account
Merchants can continue the checkout process by Creating VA using Create New Checkout API. You can enter the checkout_token obtained from the response of the create payment request API, and enter the payin_method_name that will be used in the checkout process.
Create Virtual Account [KRW]
5
VA Callback or Get VA Information
After successfully creating a virtual account, the merchant will receive a VA callback to indicate that the creation process has been completed.
The callback will contain the virtual account details, as shown in the example at the following link VA Register Callback.
Additionally, the merchant can retrieve the VA information at any time by calling the Get VA Bank Information API below.
"status": true,
"data": {
 "account_bank": "KDB",
 "account_number": "2488484848",
 "account_holder": "Paycombat"
}
}
Get VA Bank Information [KRW]
6
Create New Checkout
Merchants can continue the checkout process using the following Create New Checkout API. You can enter the checkout_token obtained from the response of the create payment request API, and enter the payin_method_name. Ensure that you use the same payin_method_name as specified in the initial Create VA API request.
Create New Checkout
7
Checkout Page
You can use checkout_url that contains the checkout_token in the Create New Checkout API Response to display the checkout page. The checkout page will display information such as Payment Amount, Payment Methods, Order Items, and Checkout Page expiration time according to the information sent in the Previous step.
In this step a payment information will also be displayed based on the Create New Checkout input.
Virtual Account
8
Redirection Url
After checkout, the customer will be automatically redirected to the redirection url according to the checkout status. The checkout status includes Completed, Failed, Cancelled and Expired. Merchant can set the redirect url in the Create Payment API request message in the Advanced_redirect_url field.
9
Webhook
Merchant will get payment status information through the webhook that we have provided below.
Webhook
Modified at 2025-07-03 03:23:21
Next
Payin - KRW (Server to Server)