포트원 결제 내역 검색
getPaymentsByFilterRetrieve payment records filtered by date range, payment method, status, and other conditions.
Instructions
포트원 서버에서 주어진 조건을 모두 만족하는 결제 내역을 검색합니다.
Note: 소문자 imp_ 혹은 imps_ 로 시작하는 거래번호는 고객사 거래번호가 아닌 V1 포트원 거래번호(imp_uid)일 가능성이 있습니다. 날짜 및 시간 정보 입출력 시에는 반드시 타임존을 명시합니다.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | paymentId / txId / imp_uid / merchant_uid 검색 필드 | |
| pg | No | 포함할 PG사 모듈 목록 | |
| to | Yes | 조회 종료 시간 (ISO 8601 형식) | |
| from | Yes | 조회 시작 시간 (ISO 8601 형식) | |
| page | Yes | 검색할 페이지 위치입니다. 0부터 시작합니다. | |
| order | No | 결제건의 주문명 | |
| types | No | 일반 / 정기결제 여부 | |
| fields | Yes | 검색 결과로 받을 필드 목록입니다. | |
| method | No | 포함할 결제수단 목록 | |
| status | No | 포함할 결제 상태 목록 | |
| channel | No | 실연동 및 테스트 포함 목록 | |
| webhook | No | 포함할 결제건의 웹훅 상태 목록 | |
| currency | No | 포함할 통화 목록, 세 자리 통화 코드 | |
| pageSize | No | 한 페이지에 반환할 결과의 수 | |
| timeType | Yes | from, to로 제약할 결제건의 기준 시각 조건 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | 페이지와 관계없이 조건에 맞는 결제 총 개수 | |
| items | Yes | 조회된 결제 목록 |