⌨️결제 복수조회(주문UQ) API
주문번호를 기준으로 결제내역을 조회합니다. 동일한 주문번호가 복수개인 경우 정렬조건으로 최우선 조회거래만 반환됩니다.
Last updated
주문번호를 기준으로 결제내역을 조회합니다. 동일한 주문번호가 복수개인 경우 정렬조건으로 최우선 조회거래만 반환됩니다.
Last updated
GET
https://api.iamport.kr /payments/find/{merchant_uid}/{payment_status}
정렬조건에 따라 최우선으로 검색되는 거래가 반환됩니다.
payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
code
* integer
응답코드
0이면 정상적인 조회, 0 이 아닌 값이면 message를 확인해봐야 합니다
message
* string
응답메세지
code 값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다
response
(PaymentAnnotation, optional)
imp_uid
* string
포트원 결제 고유 UID
merchant_uid
* string
주문번호
pay_method
* string
결제수단 구분코드
channel
* string
결제환경 구분코드
pg_provider
* string
PG사 구분코드
emb_pg_provider
* string
허브형결제 PG사 구분코드
pg_tid
* string
pg사 거래번호
pg_id
* string
PG사 MID
escrow
boolean
에스크로 결제여부
apply_num
string
신용카드 승인번호
bank_code
string
은행 표준코드(링크보기)
bank_name
string
은행 명칭
card_code
string
카드사 코드번호(금융결제원 표준코드번호 : 링크 )
card_name
string
카드사명
card_quota
integer
할부개월 수(0이면 일시불)
card_number
string
마스킹 카드번호
card_type
string
카드 구분코드
vbank_code
string
가상계좌 은행 표준코드(하단이미지 참고)
vbank_name
string
입금받을 가상계좌 은행명
vbank_holder
string
입금받을 가상계좌 예금주
vbank_date
string
입금받을 가상계좌 마감기한 (UNIX timestamp)
vbank_issued_at
string
가상계좌 생성 시각 (UNIX timestamp)
name
string
제품명
amount
* integer
주문(결제)금액
cancel_amount
integer
결제취소금액
currency
string
통화구분코드
buyer_name
string
주문자명
buyer_email
string
주문자 Email주소\
buyer_tel
string
주문자 전화번호
buyer_addr
string
주문자 주소
buyer_postcode
string
주문자 우편번호
custom_data
string
echo data JSON string으로 전달
user_agent
string
결제를 시작한 단말기의 UserAgent
status
* string
결제상태 구분코드
started_at
* string
결제시작시점 (UNIX timestamp)
paid_at
* string
결제완료시점 (UNIX timestamp)\
failed_at
* string
결제실패시점 (UNIX timestamp)
cancelled_at
* string
결제취소시점 (UNIX timestamp)
fail_reason
string
결제실패 사유
cancel_reason
string
결제취소 사유
receipt_url
string
신용카드 매출전표 확인 URL
cash_receipt_issued
boolean
현금영수증 자동발급 여부
customer_uid
string
해당 결제처리에 사용된 customer_uid
customer_uid_usage
string
customer_uid 사용 구분코드
cancel_history
(Array[PaymentCancelAnnotation], optional):
취소/부분취소 내역
cancel_history array []
pg_tid
* string
PG사 승인취소번호
amount
* integer
취소 금액
cancelled_at
* string
결제취소된 시각 UNIX timestamp
reason
* string
결제취소 사유
receipt_url
* string
취소에 대한 매출전표 확인 URL. PG사에 따라 제공되지 않는 경우도 있음
sorting
String
정렬기준 구분코드
마이너스(-) 기호가 앞에 붙으면 내림차순 정렬을 의미합니다.
-started : 결제시작시각(결제창오픈시각) 기준 내림차순(DESC) 정렬
started : 결제시작시각(결제창오픈시각) 기준 오름차순(ASC) 정렬
-paid : 결제완료시각 기준 내림차순(DESC) 정렬
paid : 결제완료시각 기준 오름차순(ASC) 정렬
-updated : 최종수정시각(결제건 상태변화마다 수정시각 변경됨) 기준 내림차순(DESC) 정렬
updated : 최종수정시각(결제건 상태변화마다 수정시각 변경됨) 기준 오름차순(ASC) 정렬
Swagger Test Link
merchant_uid*
String
주문번호
payment_status
String
거래상태 구분코드
ready(미결제)
paid(결제완료)
failed(결제실패)
cancelled(환불취소)
sorting
String
정렬구분코드