Request billing key API
Requests a billing key with credit card information.
POST https://api.iamport.kr/subscribe/customer/{customer_uid} Requests a billing key with the customer's credit card information.
Requests a billing key with the customer's credit card information.
Parameters
Path
Billing key
Body
PG code
Credit card number
XXXX-XXXX-XXXX-XXXXCredit card expiration
YYYY-MM6-digit DOB
10-digit business registration number for corporate card
First 2-digits of credit card password
CVC code
Card holder
Card holder’s phone
Card holder’s email
Card holder’s address
Card holder’s zip code
Customer ID (
For Toss Payments only
)
Responses
200: OK Success
code
* integer
Response code
0: success, Not 0: check the message
message
* string
Response message
A non-zero code includes a message like ‘Invalid payment info’.
response
(CustomerAnnotation, optional)
code
* integer
Response code
0: success, Not 0: check the message
message
* string
Response message
A non-zero code includes a message like ‘Invalid payment info’.
customer_uid
* string
Customer ID
pg_provider
* string
PG code for billing key
pg_id
* string
PG merchant ID (MID) for billing key
card_name
* string
Credit card name
card_code
* string
Credit card code
card_number
* string
Masked card number
card_type
* string
Credit card type
Not supported in some PGs (returns null)
customer_name
* string
Customer name
customer_tel
* string
Customer phone
customer_email
* string
Customer email
customer_addr
* string
Customer address
customer_postcode
* string
Customer zip code
inserted
* integer
Billing key issued at
(UNIX timestamp)
updated
* integer
Billing key updated at
(UNIX timestamp)
401: Unauthorized Missing or invalid access token
{
// Response
}
Key request parameter description
pg
* stringPG code
When using multiple MIDs for the same PG, specify as PG code.MID.
Example: PG = NHN KCP and site code = IPXC
kcp.IPXC
birth
* stringDOB
May be omitted for some PGs upon pre-agreement.
customer_id
string
For Toss Payments only
Customer ID
Using this API requires a pre-agreement with the PG.
- You may modify the required card information upon agreement with the PG.
- Special attention to security is required due to using sensitive card information.
- The
customer_uid
must be unique and issued per customer-card number pair.
Response Model Schema
Response Model Schema
{
"code": 0,
"message": "string",
"response": {
"customer_uid": "string",
"pg_provider": "string",
"pg_id": "string",
"card_name": "string",
"card_code": "string",
"card_number": "string",
"card_type": "null",
"customer_name": "string",
"customer_tel": "string",
"customer_email": "string",
"customer_addr": "string",
"customer_postcode": "string",
"inserted": 0,
"updated": 0
}
}
Swagger Test Link