⌨️Request billing key API
Last updated
Last updated
POST
https://api.iamport.kr/subscribe/customer/{customer_uid}
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
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)
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
Customer ID
For Toss Payments only
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.
Swagger Test Link
customer_uid*
String(80)
Billing key
pg*
String
PG code
card_numb*
String
Credit card number
XXXX-XXXX-XXXX-XXXX
expiry*
String
Credit card expiration
YYYY-MM
birth
String
6-digit DOB
10-digit business registration number for corporate card
pwd_2digit
String
First 2-digits of credit card password
cvc
String
CVC code
customer_name
String
Card holder
customer_tel
String
Card holder's phone
customer_email
String
Card holder's email
customer_addr
String
Card holder's address
customer_postcode
String
Card holder's zip code
customer_id
String
Customer ID (For Toss Payments only)