KakaoPay via Checkout.com

Accept KakaoPay payments from customers in South Korea with Checkout.com as the payment service provider (PSP). The customer selects KakaoPay, confirms the payment in KakaoPay, and returns to your site.

Supported workflows

Before you begin

Complete these steps before you send your first KakaoPay payment through Checkout.com:

Set up a Checkout.com integration in your workspace. Follow the Checkout.com integration setup guide if you don’t have one yet.
Ask Checkout.com to enable KakaoPay on your Checkout.com account.
In the Payrails Portal, go to Settings → Integrations, open your Checkout.com integration, select KakaoPay under Payment methods, and save.
Add KakaoPay as a payment option in your workflow.

Request fields for Checkout.com

Send these fields in the authorize request, in addition to the standard authorize fields. Required fields must be present for the payment to succeed. Payrails sends Optional fields to the PSP when you include them.

Field	Status	Description
`meta.order.lines[].unitPrice`	Required	Needed for each line when you send `meta.order.lines`. Payrails sends each line to Checkout.com as an item with its `id`, `name`, and unit price.
`meta.order.lines`	Optional	The items in the order.
`meta.order.description`	Optional	Sent to Checkout.com as the payment description.
`meta.clientContext.clientType`	Optional	Set to `app` when the customer pays from your mobile app. Payrails then tells Checkout.com to open KakaoPay for an app instead of a web page.
`meta.clientContext.osType`	Optional	`ios` or `android`. Sent with `clientType: app` so Checkout.com opens KakaoPay for the right operating system.
`meta.customer.email`	Optional	Sent to Checkout.com as the customer email.
`meta.customer.name`, `meta.customer.lastName`	Optional	Sent to Checkout.com as the customer name.
`meta.customer.phone`	Optional	Sent to Checkout.com as the customer phone number.
`meta.order.deliveryAddress`	Optional	Sent to Checkout.com as the shipping details.
`meta.order.softDescriptor`, `meta.order.softDescriptorCity`	Optional	Sent together as the billing descriptor. Checkout.com uses it only when you send both.

Authorize a KakaoPay payment

Call authorize a payment with kakaoPay as the paymentMethodCode. The response includes the redirect to KakaoPay.

Authorize request

{
  "amount": {
    "value": "10000",
    "currency": "KRW"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "kakaoPay",
      "amount": {
        "value": "10000",
        "currency": "KRW"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Minji",
      "lastName": "Kim",
      "email": "minji.kim@example.com"
    },
    "order": {
      "description": "Order 1234",
      "lines": [
        {
          "id": "item-1",
          "name": "Online course",
          "quantity": 1,
          "unitPrice": {
            "value": "10000",
            "currency": "KRW"
          }
        }
      ]
    },
    "clientContext": {
      "clientType": "app",
      "osType": "ios"
    }
  },
  "returnInfo": {
    "success": "https://example.com/success",
    "error": "https://example.com/error"
  }
}

After the customer confirms the payment, they return to your success or error URL. Confirm the result through webhook notifications or the execution status before you fulfill the order.

How Checkout.com handles KakaoPay

Checkout.com needs no payment token for KakaoPay. Payrails creates the KakaoPay source at Checkout.com from the authorize request.
Payrails sends KakaoPay payments for a web page by default. When meta.clientContext.clientType is app, Payrails asks Checkout.com for the app flow on the operating system in osType.
Checkout.com authorizes and captures KakaoPay payments in one step. Configure your workflow for instant capture.
KakaoPay through Checkout.com supports customer-initiated transactions (CIT): the customer confirms every payment in KakaoPay.

Merchant regions

Merchants based in these regions can accept KakaoPay through Checkout.com:

European Economic Area
Hong Kong
Singapore
United Kingdom

Getting Started

Payment Orchestration

Token Vault

Analytics & Reporting

Fraud Management

Chargebacks

Monitoring

Resources

Use Cases

KakaoPay via Checkout.com

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a KakaoPay payment

How Checkout.com handles KakaoPay

Merchant regions

​Supported workflows

​Before you begin

​Request fields for Checkout.com

​Authorize a KakaoPay payment

​How Checkout.com handles KakaoPay

​Merchant regions

Supported workflows

Before you begin

Request fields for Checkout.com

Authorize a KakaoPay payment

How Checkout.com handles KakaoPay

Merchant regions