KakaoPay for API only

Add KakaoPay to your API-only integration.

You can add KakaoPay to your existing integration. The following instructions show only what you must add to your integration specifically for KakaoPay.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.

Requirements

Requirement	Description
Integration type	Make sure that you have an existing API-only integration.
Redirect handling	Make sure that your existing integration is set up to handle the redirect. `action.type`: redirect.
Setup steps	Before you begin, add KakaoPay in your Customer Area.

How it works

The shopper selects KakaoPay as the payment method.
The shopper enters their details in the payment form that you build.
When you make the payment request, you include additional information about the items that the shopper intends to purchase, if applicable.
Your existing integration setup will handle the redirect.

Build your payment form

Include KakaoPay in the list of available payment methods. You do not need to collect any information from the shopper in your payment form.

You can download the logo for KakaoPay to use in your form.

Get KakaoPay as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that KakaoPay is included in the response.

Parameter	Values
countryCode	KR
amount.currency	KRW

Add additional parameters to your /payments request

You do not need to add any parameters when you make a payment.

Recurring payments

KakaoPay supports recurring transactions. To make recurring transactions, you need to:

Create a shopper token.
Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

storePaymentMethod: true
shopperReference: Your unique identifier for the shopper.

This triggers the recurring flow, where the shopper logs in to their Kakao account, then confirms the recurring transaction.

When the payment has been settled, you receive a recurring.token.created webhook containing:

type: recurring.token.created
shopperReference: your unique identifier for the shopper.
eventId: the pspReference of the initial payment.
storedPaymentMethodId: the token that you need to make recurring payments for this shopper.

Make sure that your server is able to receive the Recurring tokens life cycle events webhook. You can set up this webhook in your Customer Area.

Make a payment with a token

To make a payment with the token, include in your /payments request:

paymentMethod.storedPaymentMethodId: The storedPaymentMethodId from the recurring.token.created webhook.

You can also get this value using the /listRecurringDetails endpoint.
shopperReference: The unique shopper identifier that you specified when creating the token.
shopperInteraction: ContAuth
recurringProcessingModel: Use Subscription for a series of transactions following a fixed time interval or UnscheduledCardOnFile for contracts with non-fixed time interval.

Test and go live

To test successful KakaoPay live payments, you need to use a real mobile number registered with a KakaoPay account.

If you are encountering issues with testing KakaoPay payments, contact our Support Team.

Check the status of KakaoPay test payments in your Customer Area > Transactions > Payments.

Before you can accept live KakaoPay payments, you need to submit a request for KakaoPay in your live Customer Area.