⌨️빌링키 결제예약 조회 API

빌링키로 등록된 결졔예약내역을 조회할 수 있습니다.

Deprecated

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

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

빌링키별 결제예약목록을 조회할 수 있습니다.

빌링키 결제예약 조회

GET https://api.iamport.kr/subscribe/customers/{customer_uid}/schedules

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

Path Parameters

Name	Type	Description
customer_uid*	String	빌링키

Query Parameters

Name	Type	Description
page	integer	조회목록 페이징 1부터 시작하며 기본값은 1입니다.
from*	integer	조회 시작시각 unix timestamp
to*	integer	조회 종료시각 unix timestamp
schedule-status	String	예약상태 누락되면 모든 상태의 예약내역 조회 scheduled: 예약됨(실행되기 전) executed: 예약된 결제실행완료 revoked: 예약철회

200: OK 성공

CustomerResponse

code * integer

응답코드

0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다

message * string

응답메세지

code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

response (CustomerAnnotation, optional)

CustomerAnnotation

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

400: Bad Request 검색 파라미터가 유효하지 않은 경우

401: Unauthorized 인증 Token이 전달되지 않았거나 유효하지 않은 경우

Response Model Schema

{
  "code": 0,
  "message": "string",
  "response": [
    {
      "customer_uid": "string",
      "merchant_uid": "string",
      "imp_uid": "string",
      "schedule_at": "0",
      "executed_at": "0",
      "revoked_at": "0",
      "amount": 0,
      "name": "string",
      "buyer_name": "string",
      "buyer_email": "string",
      "buyer_tel": "string",
      "buyer_addr": "string",
      "buyer_postcode": "string",
      "custom_data": "string",
      "schedule_status": "scheduled",
      "payment_status": "paid",
      "fail_reason": "string"
    }
  ]
}

Swagger Test Link

https://api.iamport.kr/#!/subscribe.customer/findSchedulesByCustomer