결제조회 API
결제조회 API를 사용해서 승인/취소된 특정 결제 기록을 다시 확인하거나 해당 결제의 세부정보를 활용할 수 있습니다. 조회된 결제 한 건의 결제 상태, 결제취소 기록, 매출전표, 현금영수증 정보 등을 확인해보세요.
API 사용하기에서 API 사용에 필요한 인증 정보를 구성해두세요.
결제기록을 조회하는 두가지 방법
결제 기록을 조회할 수 있는 방법은 결제를 특정하는 paymentKey 로 조회하는 방법, 주문을 특정하는 orderId 로 조회하는 방법 두가지가 있습니다. API 엔드포인트와 필요한 파라미터는 다르지만 응답은 동일하게 돌아옵니다.
paymentKey로 조회하기
결제 키로 조회하려면 /v1/payments/에 Path 파라미터로 paymentKey 를 추가합니다.
요청
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.tosspayments.com/v1/payments/{paymentKey}"))
.header("Authorization", "Basic dGVzdF9ha19aT1J6ZE1hcU4zd1FkNWs2eWdyNUFrWVhRR3d5Og==")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());orderId로 조회하기
주문 Id로 조회하려면 /v1/orders/ 에 Path 파라미터로 orderId 를 추가합니다.
요청
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.tosspayments.com/v1/payments/orders/{orderId}"))
.header("Authorization", "Basic dGVzdF9ha19aT1J6ZE1hcU4zd1FkNWs2eWdyNUFrWVhRR3d5Og==")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());여러 건의 기록을 확인하고 싶다면 거래/정산조회 API를 활용하세요.