PortOne REST API

특정 PG사 관련 API

특정 PG사에 국한된 API 기능을 제공합니다.

주어진 아이디에 대응되는 카카오페이 주문 건을 조회합니다. 해당 API 사용이 필요한 경우 포트원 기술지원팀으로 문의 주시길 바랍니다.

배송 정보를 페이먼트월에 등록합니다. 등록된 배송 정보는 차지백 발생 시 고객사의 상품 배송 완료 증빙 자료로 활용되므로, 반드시 연동해야 합니다.

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다

ConfirmPaymentwallDeliveryBody: { transactionId, deliveryType, deliveryStatus, ... }

페이먼트월 배송 정보 등록 입력 정보

ConfirmPaymentwallDeliveryResponse: { }

페이먼트월 배송 정보 등록 성공 응답

Country: "AD" | "AE" | "AF" | ...

국가

GetKakaopayPaymentOrderResponse: { statusCode, body }

카카오페이 주문 조회 응답

InvalidRequestError: { type, message }

요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

PaymentNotFoundError: { type, message }

결제 건이 존재하지 않는 경우

PaymentwallDeliveryStatus: "ORDER_PLACED" | "ORDER_SHIPPED" | "DELIVERED"

페이먼트월 배송 상태

PaymentwallDeliveryType: "DIGITAL" | "PHYSICAL"

페이먼트월 배송 유형

UnauthorizedError: { type, message }

인증 정보가 올바르지 않은 경우