개발자센터

빌링키 관련 API

빌링키 관리와 관련된 기능을 제공합니다.
여러 개의 빌링키를 한 번에 조회하는 API입니다.

등록된 카드마다 1개의 customer_uid가 매핑되므로, 고객사 시스템 내에 1명의 고객이 여러 장의 카드를 등록할 수 있는 경우 여러 개의 customer_uid를 가지게 됩니다.
해당 고객이 등록해놓은 카드정보 목록을 한 번에 조회하는데 사용하면 편리합니다.

예시) /subscribe/customers?customer_uid[]=hong_1234_a&customer_uid[]=hong_1234_b
구매자의 빌링키 정보 조회
구매자에 대해 빌링키 발급 및 저장
해당 빌링키 발급 API는 PG사와 협의가 완료된 경우 이용 가능한 서비스입니다.
  • PG사 협의를 통해 카드정보 필수 조건 값 조정이 가능합니다.
  • 민감한 카드정보를 이용하기 때문에 보안에 특히 유의하셔야 합니다.
  • customer_uid 값은 고객 & 카드번호 단위별로 고유하게 발급 관리되어야 합니다
구매자의 빌링키 정보 삭제
빌링키 삭제시 결제예약된 내역이 존재하는지 반드시 확인하셔야 합니다.
삭제된 빌링키는 복구할 수 없습니다.
구매자의 빌링키로 결제된 결제목록을 조회합니다.
결제예약 복수조회(빌키) API와 동일한 동작을 하는 API입니다.

customer_uid별 결제예약목록을 조회할 수 있습니다. 결제예약정보가 (페이징된)목록으로 전달되며, 최대 3개월 단위로 조회가 가능합니다.

결제예약정보가 예약된 시각 기준으로 최신순으로 정렬되어 전달됩니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
CustomerAnnotation: { customer_uid, pg_provider, pg_id, ... }
CustomerResponse: { code, message, response }
일반 빌링키 응답
FailedChannelAnnotation: { type, message, pg_provider, ... }
MultipleCustomersResponse: { code, message, response }
PagedPaymentAnnotation: { total, previous, next, ... }
PaymentAnnotation: { imp_uid, merchant_uid, pay_method, ... }
PaymentCancelAnnotation: { pg_tid, amount, cancelled_at, ... }
PaymentListResponse: { code, message, response }
ResponseAnnotation: { code, message }
ScheduleResponse: { code, message, response }
ScheduleResultAnnotation: { customer_uid, merchant_uid, imp_uid, ... }
SucceededChannelAnnotation: { pg_provider, pg_id, card_name, ... }
SuperBillingKeyAnnotation: { customer_uid, channelGroupId, customer_id, ... }
SuperBillingKeyResponse: { code, message, response }
슈퍼 빌링키 응답
VbankDepositAnnotation: { pg_tid, amount, depositor_name, ... }