Payment management

This document describes how to use the Payment management APIs.

Create virtual account for direct deposit

Basic information

Method	URL	Authorization
POST	https://apis.moment.kakao.com/openapi/v4/billing/virtualAccount	Access token

Permission	Prerequisite	Kakao Login	User consent
Required	Register platforms Activate Kakao Login Switch to a Biz app	Required	-

This API enables you to create a virtual account for direct deposit.

Send a POST request with the issued access token and an ad account ID (adAccountId) in the request header. You must pass the bank code where a virtual account will be created and the deposit amount when you request. If failed, refer to Error code to figure out its failure cause.

This API limits the number of calls you can make to every second per user account.

Request

Header

Name	Description	Required
Authorization	Authorization: Bearer ${ACCESS_TOKEN} Access token as a type of user authentication.	O
adAccountId	adAccountId: ${AD_ACCOUNT_ID} Ad account's ID.	O

Body

Name	Type	Description	Required
amount	Integer	Deposit amount.	O
bankCode	String	Bank code. 03: 기업은행 (IBK) 04: 국민은행 (KB Bank) 11: 농협은행 (Nonghyup Bank) 81: 하나은행 (Hana Bank) 20: 우리은행 (Woori Bank) 88: 신한은행 (Shinhan Bank) 39: 경남은행 (Kyongnam Bank) 71: 우체국 (Post Office) 32: 부산은행 (Busan Bank) 31: 대구은행 (Daegu Bank)	O

Response

Body

Name	Type	Description
accountNumber	String	Virtual account's number.
accountOwnerName	String	Virtual account's holder name.
amount	Integer	Deposit amount.
bankCode	String	Bank code.
bankName	String	Bank name.
expireDttm	String	Virtual account expiration date.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/billing/virtualAccount" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -d '{
            "amount" : 1000000,
            "bankCode" : "88"
        }'

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "accountNumber": "X123456789012",
    "accountOwnerName": "(주)카카오",
    "amount": 1000000,
    "bankCode": "88",
    "bankName": "신한",
    "expireDttm": "2020-08-17T17:28:12.683"
}

See more

• Kakao Moment API Reference