KakaoPay
KakaoPay is a mobile payment and digital wallet service launched in September 2014 by KakaoPay Corporation. It ranks among South Korea's top three mobile payment services , with over 40 million users. Learn more about KakaoPay.
Payment method properties
Markets | KR |
Processing currencies | KRW |
Consumer currencies | KRW |
Settlement currencies | USD |
Authentication methods | REDIRECT |
Minimum payment amount | 50 KRW |
Maximum payment amount | 2,000,000 KRW |
Recurring payments | Yes |
Separate captures | No |
Refund | Full - Partial - Multiple |
Refund validity | 365 days |
Chargeback | No |
Sandbox availability | KakaoPay sandbox |
Make a KakaoPay payment
KakaoPay follows our standardized REDIRECT
payment flow. However, we recommend including all relevant settings for any authentication methods you support.
To create a KakaoPay payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:
Data Field | Description |
---|---|
paymentMethod | KAKAOPAY |
paymentDescriptor | The order description. |
amount.value | The amount to be paid in the smallest units of the currency used. |
amount.currency | KRW |
consumer.name | Full name of the consumer. |
consumer.country | The country where the consumer is shopping. |
authenticationSettings: REDIRECT settings.returnUrl | Add the URL where the consumer should be redirected after they complete the payment. |
Request
POST /v1/payment-charges
{
"paymentMethod": "KAKAOPAY",
"paymentDescriptor": "Order description",
"amount": {
"value": 15000,
"currency": "KRW"
},
"consumer": {
"name": "John Smith",
"country": "KR"
},
"authenticationSettings": [
{
"type": "REDIRECT",
"settings": {
"returnUrl": "https://www.webshop.com/order-results-page"
}
}
]
}
Response
You'll receive our standard payment charge response (see potential responses in the API Reference)
{
"id": "charge_X0O78tadFHrZCbGhkycPk",
"status": "AUTHENTICATION_PENDING",
// ...
"authenticationMethods": [
{
"type": "REDIRECT",
"details": {
"requestUrl": "https://redirection-target.ppro.com",
"requestMethod": "GET"
}
}
]
}
Pick the desired authentication method
REDIRECT
- Redirect your consumer to the returned
$.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl
.
For example, with the value ofhttps://redirection-target.ppro.com/
using the returned$.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod
HTTP method. - The consumer will be presented with the reference number and instructions to complete the payment.
Handling the payment result
REDIRECT
- After the consumer completes the payment, they are redirected to the
returnUrl
specified in the payment charge creation request. - Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned
status
field to determine and display the final payment outcome to the consumer. - Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.
Updated 4 months ago