latestSwagger 2.02026-07-177680526.3 KB

006dfffdec43

payments

결제 단건조회(고유 고객사 주문번호 조회) API

고객사지정 고유번호로 결제내역을 확인합니다 <br> 동일한 merchant_uid가 여러 건 존재하는 경우, 정렬 기준에 따라 가장 첫 번째 해당되는 건을 반환합니다. (모든 내역에 대한 조회가 필요하시면 GET 결제 복수조회(고객사 주문번호 중복 포함) API를 사용해주세요.)<br><br> payment_status를 추가로 지정하시면, 해당 status에 해당하는 가장 최신 데이터를 반환합니다.

get/payments/find/{merchant_uid}/{payment_status}

Path parameters

merchant_uidstring required

결제요청 시 고객사에서 요청한 merchant_uid

payment_statusstring required

특정 status상태의 값만 필터링하고 싶은 경우에 사용.<br>지정하지 않으면 모든 상태를 대상으로 조회합니다. <ul><li>ready(미결제)</li> <li>paid(결제완료)</li> <li>failed(결제실패)</li> <li>cancelled(환불취소)</li> </ul>

Query parameters

sorting'-started' | 'started' | '-paid' | 'paid' | '-updated' | 'updated'

기본값은 -started<br>마이너스(-) 기호가 앞에 붙으면 내림차순 정렬을 의미합니다.<br> <ul> <li>-started : 결제시작시각(결제창오픈시각) 기준 내림차순(DESC) 정렬 </li> <li>started : 결제시작시각(결제창오픈시각) 기준 오름차순(ASC) 정렬 </li><li>-paid : 결제완료시각 기준 내림차순(DESC) 정렬 </li><li>paid : 결제완료시각 기준 오름차순(ASC) 정렬 </li><li>-updated : 최종수정시각(결제건 상태변화마다 수정시각 변경됨) 기준 내림차순(DESC) 정렬 </li> <li>updated : 최종수정시각(결제건 상태변화마다 수정시각 변경됨) 기준 오름차순(ASC) 정렬</li></ul>

Response

정상 조회

PaymentResponse required— unresolved $ref