개발자센터

에스크로 관련 API

에스크로 결제 건의 배송 정보와 관련된 기능을 제공합니다.
에스크로 결제 건에 대한 배송정보 조회
입력한 배송정보를 획득합니다.

택배사 코드표 : https://developers.portone.io/docs/ko/tip/code

지원되는 PG사

  • KG이니시스
  • NHN KCP
  • 키움페이(구 다우, 페이조아)(다우테이타)
  • KSNET
  • 스마트로 - 신모듈(PG사와의 사전 계약이 반드시 필요합니다.)
  • (신) 나이스페이
  • 웰컴페이먼츠
에스크로 결제 건에 대해서 PUT /escrows/logis/{imp_uid} 로 등록된 배송정보를 수정하는 API 입니다.(2-depth의 json으로 Request Body가 구성되어야 합니다)

logis는 하위 필드가 모두 필수입니다.
sender, receiver의 각 세부 항목은 PG사마다 필수 여부가 모두 다릅니다.

지원되는 PG사

  • KG이니시스
  • 키움페이(구 다우, 페이조아)(다우테이타)
  • KSNET
  • 스마트로 - 신모듈 (PG사와의 사전 계약이 반드시 필요합니다.)
  • 웰컴페이먼츠
에스크로 결제 건에 대한 배송정보 등록(2-depth의 json으로 Request Body가 구성되어야 합니다)

logis는 하위 필드가 모두 필수입니다.
sender, receiver의 각 세부 항목은 PG사마다 필수 여부가 모두 다릅니다.

지원되는 PG사

  • KG이니시스
  • NHN KCP (등록만 가능하며, 배송정보 단건수정 API로 수정할 수 없습니다.)
  • 키움페이(구 다우, 페이조아)(다우테이타)
  • KSNET
  • 스마트로 - 신모듈(PG사와의 사전 계약이 반드시 필요합니다.)
  • (신) 나이스페이 (등록만 가능하며, 배송정보 단건수정 API로 수정할 수 없습니다.)
  • 웰컴페이먼츠

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
EscrowLogisAnnotation: { company, invoice, sent_at, ... }
EscrowLogisGetAnnotation: { company, invoice, applied_at }
EscrowLogisGetResponse: { code, message, response }
EscrowLogisInfoAnnotation: { company, invoice, sent_at, ... }
EscrowLogisProductsAnnotation: { id, name, code, ... }
EscrowLogisReceiverAnnotation: { name, tel, addr, ... }
EscrowLogisResponse: { code, message, response }
EscrowLogisSenderAnnotation: { name, tel, addr, ... }
ResponseAnnotation: { code, message }