⌨️빌링키 정보 복수조회 API

복수개의 빌링키를 이용하여 빌링키 정보를 조회할수 있습니다.

Deprecated

이 문서는 더 이상 관리되지 않습니다.

PortOne 개발자센터를 이용해주세요.

복수개의 빌링키 정보를 입력하여 각각의 빌링키 정보를 조회할 수 있습니다.

빌링정보 복수조회 API

GET https://api.iamport.kr/subscribe/customers

등록된 카드마다 1개의

customer_uid

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

Query Parameters

NameTypeDescription

customer_uid[]*

Array

빌키

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

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
    }
  ]
}

Last updated