⌨️결제예약 복수조회 API
예약된 결제내역을 조회할 수 있는 API 입니다.
기간범위를 지정하여 결제예약목록을 조회할 수 있습니다.
예약된 결재내역 조회 API
GET
https://api.iamport.kr/subscribe/payments/schedule
결제예약정보가 예약된 시각 기준으로 최신순으로 정렬되어 전달됩니다. 과거순으로 정렬하기 위해서는
sorting=scheduled
파라미터를 지정하시면 됩니다.
Query Parameters
Name | Type | Description |
---|---|---|
schedule_from* | integer | 조회 시작시각 (unix timestamp) |
schedule_to* | integer | 조회 종료시각 (unix timestamp) |
schedule_status | String | 예약상태
|
page | integer | 조회목록 페이징 1부터 시작하며 기본값은 1입니다. |
limit | integer | 페이지당 조회건수 최대 1000건 기본값 20건 |
sorting | String | 정렬방식 Default : 예약일자 최신 scheduled : 예약일자 과거순 |
code
integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message
string
응답메세지
code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
response
(Array[ScheduleResultAnnotation], optional
code
integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message
string
응답메세지
code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
customer_uid
string
빌링키
merchant_uid
string
주문번호
imp_uid
* string
포트원 결제 고유 UID
schedule_at
UNIX timestamp
예약결제 실행 예정 시각
executed_at
UNIX timestamp
예약결제가 실행된 시각
revoked_at
UNIX timestamp
예약결제 실행을 철회한 시각
amount
integer
주문(결제)금액
name
string
제품명
buyer_name
string
주문자명
buyer_email
string
주문자 Email주소
\
buyer_tel
string
주문자 전화번호
buyer_addr
string
주문자 주소
buyer_postcode
string
주문자 우편번호
custom_data
string
echo data JSON string으로 전달
schedule_status
string
예약상태
scheduled
: 예약됨(실행되기 전)executed
: 예약된 결제실행완료revoked
: 예약철회
payment_status
string
실행된 결제의 승인 상태
null
: 아직 예약결제가 실행되지 않음(null 이라는 값의 문자열이 아닌 실제 null 입니다)paid
: 예약결제가 결제승인됨failed
: 예약결제가 승인실패됨cancelled
: 예약결제가 결제승인 후 환불됨
fail_reason
string
실패사유
Swagger Test Link
Last updated