⌨️빌링키 발급 API
카드정보를 이용하여 빌링키를 발급할수 있는 API 입니다.
빌링키 발급 API
POST
https://api.iamport.kr/subscribe/customers/{customer_uid}
구매자에 대해 빌링키 발급을 요청 할 수 있습니다.
Path Parameters
Name | Type | Description |
---|---|---|
customer_uid* | String(80) | 빌링키 |
Request Body
Name | Type | Description |
---|---|---|
pg | String | PG 구분코드 |
card_number* | String | 카드번호 XXXX-XXXX-XXXX-XXXX |
expiry* | String | 카드 유효기간 YYYY-MM |
birth | String | 생년월일 6자리 법인카드인 경우 사업자 번호 10자리 |
pwd_2digit | String | 카드비밀번호 앞 2자리 |
cvc | String | 카드 인증번호 |
customer_name | String | 카드소유자명 |
customer_tel | String | 카드소유자 연락처 |
customer_email | String | 카드소유자 이메일주소 |
customer_addr | String | 카드소유자 주소 |
customer_postcode | String | 카드소유자 우편번호 |
customer_id | String | 구매자 ID( 토스페이먼츠 전용 ) |
code
* integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message
* string
응답메세지
code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
response
(CustomerAnnotation, optional)
code
* integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message
* string
응답메세지
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
customer_uid
* string
고객 고유번호
\
pg_provider
* string
빌링키가 등록된 PG사 코드
pg_id
* string
빌링키가 등록된 PG사 상점아이디(MID)
card_name
* string
카드사명
card_code
* string
카드사 코드
card_number
* string
마스킹 카드번호
card_type
* string
카드유형
(주의)해당 정보를 제공하지 않는 일부 PG사의 경우 null 로 응답됨
customer_name
* string
고객성함
customer_tel
* string
고객 전화번호
customer_email
* string
고객 Email
customer_addr
* string
고객 주소
customer_postcode
* string
고객 우편번호
inserted
* integer
빌키가 등록된 시각
UNIX timestamp
updated
* integer
빌키가 업데이트된 시각
UNIX timestamp
주요 요청 파라미터 상세 설명
pg
* stringPG 구분코드
한 PG사에 복수개 MID 를 이용중인 경우 PG구분코드.MID 형태로 기입하시면 됩니다.
ex) NHN KCP를 사용하고 사이트 코드가 IPXC 인 경우
kcp.IPXC
birth
* string생년월일
일부 PG사에 한하여 생략 가능(PG사 협의 필요)
customer_id
string
구매자 ID
빌링키를 발급한 고객의 고유 ID 토스페이먼츠 전용
해당 빌링키 발급 API 는 PG사와 협의가 완료된 경우 이용 가능한 서비스입니다.
PG사 협의를 통해 카드정보 필수 조건 값 조정이 가능합니다.
민감한 카드정보를 이용하기 때문에 보안에 특히 유의하셔야 합니다.
customer_uid 값은 고객 & 카드번호 단위별로 고유하게 발급 관리되어야 합니다
Swagger Test Link
Last updated