KakaoPay Drop-in integration

Add KakaoPay to anexisting iOS Drop-in integration.

This page explains how to add KakaoPay to your existing iOS Drop-in integration.

Requirements

Select the server-side flow that your integration uses:

API reference

You do not need to send additional fields for KakaoPay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

/sessions: This is the default with Drop-in v5.0.0 or later.
/payments: If you implemented an additional use case.

Drop-in configuration

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 webhook containing:

eventCode: RECURRING_CONTRACT
originalReference: The pspReference of the initial payment.
pspReference: This is the token that you need to make recurring payments for this shopper.

Make sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.

Make a payment with a token

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

paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT 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.