PortOne REST API - V2
API 결제, 결제 정보 조회, 결제 취소 등의 기능을 제공하는 REST API입니다.
V2 API hostname: api.portone.io
요청 및 응답 형식
요청과 응답의 본문은 JSON 형식입니다.
API 매개 변수 중 URL 경로에 들어가는 문자열 값이 있는 경우, URL 경로에 들어갈 수 없는 문자열은 이스케이프하여야 합니다. 자바스크립트의 encodeURIComponent 함수 등을 사용할 수 있습니다.
인증 방식
V2 API를 사용하기 위해서는 V2 API Secret이 필요하며, 포트원 관리자콘솔 내 결제연동 탭에서 발급받으실 수 있습니다.
인증 관련 API를 제외한 모든 API는 HTTP Authorization 헤더로 아래 형식의 인증 정보를 전달해주셔야 합니다.
Authorization: PortOne MY_API_SECRET
GET 요청 시 Body 대신 Query 사용하기
GET 요청 시에 Body를 전달해야 하는 경우, Body 대신 Query를 사용할 수 있습니다.
이 경우, Body 객체를 requestBody Query 필드에 넣어주시면 됩니다.
하위호환성
포트원이 제공하는 모든 Stable API에 대해 아래와 같은 하위호환성이 보장됩니다.
현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.
- 입력 형식 내 필드 정의가 삭제되지 않습니다.
필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.
- 오로지 선택 입력 정보만 추가될 수 있습니다.
- 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
- enum 타입의 값이 삭제되지 않습니다.
출력 형식이 확장될 수 있지만, 축소되지 않습니다.
- 출력 형식 내 필드 정의가 삭제되지 않습니다.
사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.
- 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
- 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.
- 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
단, 새로운 필드 또는 enum 값, oneOf 케이스가 추가될 수 있습니다.
- 알지 못하는 필드 및 값이 주어지더라도 crash가 발생하지 않도록 유의하여 개발해주세요.
UNSTABLE이 표기된 일부 API의 경우, 위 하위호환성 정책과 무관하게 변경 및 지원 종료될 수 있으니 이용에 유의하세요.
인증 관련 API
인증과 관련된 API 기능을 제공합니다.
결제 관련 API
결제와 관련된 API 기능을 제공합니다.
목차
결제 정보 사전 등록
post/payments/{paymentId}/pre-register결제 단건 조회
get/payments/{paymentId}결제 다건 조회(페이지 기반)
get/payments결제 대용량 다건 조회(커서 기반)
get/payments-by-cursor결제 취소
post/payments/{paymentId}/cancel빌링키 결제
post/payments/{paymentId}/billing-key수기 결제
post/payments/{paymentId}/instant가상계좌 말소
post/payments/{paymentId}/virtual-account/close에스크로 배송 정보 등록
post/payments/{paymentId}/escrow/logistics에스크로 배송 정보 수정
patch/payments/{paymentId}/escrow/logistics에스크로 구매 확정
post/payments/{paymentId}/escrow/complete웹훅 재발송
post/payments/{paymentId}/resend-webhook영수증 내 하위 상점 거래 등록
post/payments/{paymentId}/register-store-receipt결제 예약 관련 API
빌링키 관련 API
현금 영수증 관련 API
프로모션 관련 API
프로모션과 관련된 API 기능을 제공합니다.
본인인증 관련 API
파트너 정산 관련 API
파트너 정산 서비스 API 기능을 제공합니다.
정책 관련 API
파트너 정산에 적용할 정책에 관한 API 입니다.
목차
할인 분담 정책 다건 조회
get/platform/discount-share-policies할인 분담 정책 생성
post/platform/discount-share-policies할인 분담 정책 조회
get/platform/discount-share-policies/{id}할인 분담 정책 수정
patch/platform/discount-share-policies/{id}할인 분담 정책 보관
post/platform/discount-share-policies/{id}/archive할인 분담 정책 복원
post/platform/discount-share-policies/{id}/recover추가 수수료 정책 다건 조회
get/platform/additional-fee-policies추가 수수료 정책 생성
post/platform/additional-fee-policies추가 수수료 정책 조회
get/platform/additional-fee-policies/{id}추가 수수료 정책 수정
patch/platform/additional-fee-policies/{id}추가 수수료 정책 보관
post/platform/additional-fee-policies/{id}/archive추가 수수료 정책 복원
post/platform/additional-fee-policies/{id}/recover계약 다건 조회
get/platform/contracts계약 생성
post/platform/contracts계약 조회
get/platform/contracts/{id}계약 수정
patch/platform/contracts/{id}계약 보관
post/platform/contracts/{id}/archive계약 복원
post/platform/contracts/{id}/recoverget/platform/discount-share-policies
할인 분담 정책 다건 조회
여러 할인 분담을 조회합니다.
Request
body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기
Body
다건 조회 API 에 사용되는 페이지 입력 정보
(Optional)
다건 조회 API 에 사용되는 페이지 입력 정보
number?: integer (32 bit)
0부터 시작하는 페이지 번호
(Optional)
size?: integer (32 bit)
각 페이지 당 포함할 객체 수
(Optional)
할인 분담 정책 다건 조회를 위한 필터 조건
(Optional)
할인 분담 정책 다건 조회를 위한 필터 조건
isArchived?: boolean
보관 조회 여부
(Optional)
true 이면 보관된 할인 분담 정책을 조회하고, false 이면 보관되지 않은 할인 분담 정책을 조회합니다. 기본값은 false 입니다.
partnerShareRates?: integer[]
(Optional)
하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 파트너 분담율을 가진 할인 분담 정책만 조회합니다.
검색 키워드 입력 정보
(Optional)
검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 할인 분담 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.
Response
200
성공 응답으로 조회된 할인 분담 정책 리스트와 페이지 정보가 반환됩니다.
조회된 할인 분담 정책 리스트
id: string
graphqlId: string
name: string
할인 분담 정책 이름
partnerShareRate: integer (32 bit)
할인 분담율
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모
(Optional)
isArchived: boolean
보관 여부
변경 적용 시점
반환된 페이지 결과 정보
반환된 페이지 결과 정보
number: integer (32 bit)
요청된 페이지 번호
size: integer (32 bit)
요청된 페이지 당 객체 수
totalCount: integer (32 bit)
실제 반환된 객체 수
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/discount-share-policies
할인 분담 정책 생성
새로운 할인 분담을 생성합니다.
Request
Body
id?: string
할인 분담에 부여할 고유 아이디
(Optional)
명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name: string
할인 분담에 부여할 이름
partnerShareRate: integer (32 bit)
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 `할인금액 * partnerShareRate * 10^5` 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모 ex) 파트너 브랜드 쿠폰
(Optional)
Response
200
성공 응답으로 생성된 할인 분담 정책이 반환됩니다.
할인 분담 정책
할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.
id: string
graphqlId: string
name: string
할인 분담 정책 이름
partnerShareRate: integer (32 bit)
할인 분담율
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모
(Optional)
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
409
PlatformDiscountSharePolicyAlreadyExistsError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformDiscountSharePolicyAlreadyExistsError 입니다.
message?: string
(Optional)
try
Request
Request Sample
get/platform/discount-share-policies/{id}
할인 분담 정책 조회
주어진 아이디에 대응되는 할인 분담을 조회합니다.
Request
Path
id: string
조회할 할인 분담 정책 아이디
조회할 할인 분담 정책 아이디
Response
200
성공 응답으로 할인 분담 정책을 반환합니다.
id: string
graphqlId: string
name: string
할인 분담 정책 이름
partnerShareRate: integer (32 bit)
할인 분담율
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모
(Optional)
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformDiscountSharePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformDiscountSharePolicyNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
patch/platform/discount-share-policies/{id}
할인 분담 정책 수정
주어진 아이디에 대응되는 할인 분담을 업데이트합니다.
Request
Path
id: string
업데이트할 할인 분담 정책 아이디
업데이트할 할인 분담 정책 아이디
Body
name?: string
할인 분담 정책 이름
(Optional)
partnerShareRate?: integer (32 bit)
할인 분담율
(Optional)
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모
(Optional)
Response
200
성공 응답으로 업데이트된 할인 분담 정책을 반환합니다.
할인 분담 정책
할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.
id: string
graphqlId: string
name: string
할인 분담 정책 이름
partnerShareRate: integer (32 bit)
할인 분담율
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모
(Optional)
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformDiscountSharePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformDiscountSharePolicyNotFoundError 입니다.
message?: string
(Optional)
409
PlatformArchivedDiscountSharePolicyError: 보관된 할인 분담 정책을 업데이트하려고 하는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformArchivedDiscountSharePolicyError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/discount-share-policies/{id}/archive
할인 분담 정책 보관
주어진 아이디에 대응되는 할인 분담을 보관합니다.
Request
Path
id: string
할인 분담 아이디
할인 분담 아이디
Response
200
성공 응답으로 보관된 할인 분담 객체를 반환합니다.
할인 분담 정책
할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.
id: string
graphqlId: string
name: string
할인 분담 정책 이름
partnerShareRate: integer (32 bit)
할인 분담율
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모
(Optional)
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformDiscountSharePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformDiscountSharePolicyNotFoundError 입니다.
message?: string
(Optional)
409
PlatformCannotArchiveScheduledDiscountSharePolicyError: 예약된 업데이트가 있는 할인 분담 정책을 보관하려고 하는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformCannotArchiveScheduledDiscountSharePolicyError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/discount-share-policies/{id}/recover
할인 분담 정책 복원
주어진 아이디에 대응되는 할인 분담을 복원합니다.
Request
Path
id: string
할인 분담 아이디
할인 분담 아이디
Response
200
성공 응답으로 복원된 할인 분담 객체를 반환합니다.
할인 분담 정책
할인 분담은 고객사의 주문건에 쿠폰 및 포인트와 같은 할인금액이 적용될 때, 파트너 정산 시 할인금액에 대한 분담 정책을 가지는 객체입니다. 할인 유형에 대한 아이디와 메모, 그리고 파트너 분담율을 가집니다.
id: string
graphqlId: string
name: string
할인 분담 정책 이름
partnerShareRate: integer (32 bit)
할인 분담율
파트너가 분담할 할인금액의 비율을 의미하는 밀리 퍼센트 단위 (10^-5) 의 음이 아닌 정수이며, 파트너가 부담할 금액은 할인금액 * partnerShareRate * 10^5 로 책정합니다.
memo?: string
해당 할인 분담에 대한 메모
(Optional)
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformDiscountSharePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformDiscountSharePolicyNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
get/platform/additional-fee-policies
추가 수수료 정책 다건 조회
여러 추가 수수료 정책을 조회합니다.
Request
body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기
Body
다건 조회 API 에 사용되는 페이지 입력 정보
(Optional)
다건 조회 API 에 사용되는 페이지 입력 정보
number?: integer (32 bit)
0부터 시작하는 페이지 번호
(Optional)
size?: integer (32 bit)
각 페이지 당 포함할 객체 수
(Optional)
추가 수수료 정책 다건 조회를 위한 필터 조건
(Optional)
추가 수수료 정책 다건 조회를 위한 필터 조건
isArchived?: boolean
보관 조회 여부
(Optional)
true 이면 보관된 추가 수수료 정책의 필터 옵션을 조회하고, false 이면 보관되지 않은 추가 수수료 정책의 필터 옵션을 조회합니다. 기본값은 false 입니다.
금액 부담 주체
(Optional)
하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 부가세 부담 주체에 해당하는 추가 수수료 정책만 조회합니다.
검색 키워드 입력 정보
(Optional)
검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 추가 수수료 정책만 조회합니다. 하위 필드는 명시된 값 중 한 가지만 적용됩니다.
Response
200
성공 응답으로 조회된 추가 수수료 정책 리스트와 페이지 정보를 반환합니다.
조회된 추가 수수료 정책 리스트
id: string
추가 수수료 정책 고유 아이디
graphqlId: string
name: string
추가 수수료 정책 이름
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
memo?: string
해당 추가 수수료 정책에 대한 메모
(Optional)
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
isArchived: boolean
보관 여부
변경 적용 시점
반환된 페이지 결과 정보
반환된 페이지 결과 정보
number: integer (32 bit)
요청된 페이지 번호
size: integer (32 bit)
요청된 페이지 당 객체 수
totalCount: integer (32 bit)
실제 반환된 객체 수
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/additional-fee-policies
추가 수수료 정책 생성
새로운 추가 수수료 정책을 생성합니다.
Request
Body
id?: string
생성할 추가 수수료 정책 아이디
(Optional)
명시하지 않으면 id 가 임의로 생성됩니다.
name: string
이름
수수료 계산 방식을 특정하기 위한 입력 정보
정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다.
두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.
fixedRate?: integer (32 bit)
정률 수수료
(Optional)
fixedAmount?: integer (64 bit)
정액 수수료
(Optional)
memo?: string
메모
(Optional)
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PARTNER파트너가 부담하는 경우MERCHANT고객사가 부담하는 경우Response
200
성공 응답
추가 수수료 정책
추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.
id: string
추가 수수료 정책 고유 아이디
graphqlId: string
name: string
추가 수수료 정책 이름
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
memo?: string
해당 추가 수수료 정책에 대한 메모
(Optional)
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
409
PlatformAdditionalFeePolicyAlreadyExistsError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAdditionalFeePolicyAlreadyExistsError 입니다.
message?: string
(Optional)
try
Request
Request Sample
get/platform/additional-fee-policies/{id}
추가 수수료 정책 조회
주어진 아이디에 대응되는 추가 수수료 정책을 조회합니다.
Request
Path
id: string
조회할 추가 수수료 정책 아이디
조회할 추가 수수료 정책 아이디
Response
200
성공 응답으로 추가 수수료 정책을 반환합니다.
id: string
추가 수수료 정책 고유 아이디
graphqlId: string
name: string
추가 수수료 정책 이름
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformFixedAmountFee 입니다.
amount: integer (64 bit)
고정된 수수료 금액
memo?: string
해당 추가 수수료 정책에 대한 메모
(Optional)
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PARTNER파트너가 부담하는 경우MERCHANT고객사가 부담하는 경우isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformAdditionalFeePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAdditionalFeePolicyNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
patch/platform/additional-fee-policies/{id}
추가 수수료 정책 수정
주어진 아이디에 대응되는 추가 수수료 정책을 업데이트합니다.
Request
Path
id: string
업데이트할 추가 수수료 정책 아이디
업데이트할 추가 수수료 정책 아이디
Body
수수료 계산 방식을 특정하기 위한 입력 정보
(Optional)
정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다.
두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.
fixedRate?: integer (32 bit)
정률 수수료
(Optional)
fixedAmount?: integer (64 bit)
정액 수수료
(Optional)
name?: string
추가 수수료 정책 이름
(Optional)
memo?: string
해당 추가 수수료 정책에 대한 메모
(Optional)
금액 부담 주체
(Optional)
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PARTNER파트너가 부담하는 경우MERCHANT고객사가 부담하는 경우Response
200
성공 응답으로 업데이트된 추가 수수료 정책이 반환됩니다.
추가 수수료 정책
추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.
id: string
추가 수수료 정책 고유 아이디
graphqlId: string
name: string
추가 수수료 정책 이름
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
memo?: string
해당 추가 수수료 정책에 대한 메모
(Optional)
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformAdditionalFeePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAdditionalFeePolicyNotFoundError 입니다.
message?: string
(Optional)
409
PlatformArchivedAdditionalFeePolicyError: 보관된 추가 수수료 정책을 업데이트하려고 하는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformArchivedAdditionalFeePolicyError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/additional-fee-policies/{id}/archive
추가 수수료 정책 보관
주어진 아이디에 대응되는 추가 수수료 정책을 보관합니다.
Request
Path
id: string
추가 수수료 정책 아이디
추가 수수료 정책 아이디
Response
200
성공 응답으로 보관된 추가 수수료 정책 객체를 반환합니다.
추가 수수료 정책
추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.
id: string
추가 수수료 정책 고유 아이디
graphqlId: string
name: string
추가 수수료 정책 이름
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
memo?: string
해당 추가 수수료 정책에 대한 메모
(Optional)
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformAdditionalFeePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAdditionalFeePolicyNotFoundError 입니다.
message?: string
(Optional)
409
PlatformCannotArchiveScheduledAdditionalFeePolicyError: 예약된 업데이트가 있는 추가 수수료 정책을 보관하려고 하는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformCannotArchiveScheduledAdditionalFeePolicyError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/additional-fee-policies/{id}/recover
추가 수수료 정책 복원
주어진 아이디에 대응되는 추가 수수료 정책을 복원합니다.
Request
Path
id: string
추가 수수료 정책 아이디
추가 수수료 정책 아이디
Response
200
성공 응답으로 복원된 추가 수수료 정책 객체를 반환합니다.
추가 수수료 정책
추가 수수료 정책는 고객사의 주문건에 대한 중개수수료에 별도로 추가로 부여되는 수수료입니다. 대표적인 사용 예시로 풀필먼트 수수료, 로켓배송 수수료, 마케팅 채널 수수료등이 있습니다.
id: string
추가 수수료 정책 고유 아이디
graphqlId: string
name: string
추가 수수료 정책 이름
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
memo?: string
해당 추가 수수료 정책에 대한 메모
(Optional)
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformAdditionalFeePolicyNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAdditionalFeePolicyNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
get/platform/contracts
계약 다건 조회
여러 계약을 조회합니다.
Request
body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기
Body
다건 조회 API 에 사용되는 페이지 입력 정보
(Optional)
다건 조회 API 에 사용되는 페이지 입력 정보
number?: integer (32 bit)
0부터 시작하는 페이지 번호
(Optional)
size?: integer (32 bit)
각 페이지 당 포함할 객체 수
(Optional)
계약 다건 조회를 위한 필터 조건
(Optional)
계약 다건 조회를 위한 필터 조건
금액 부담 주체
(Optional)
하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 수수료 부담 주체를 가진 계약만 조회합니다.
플랫폼 정산 주기 계산 방식
(Optional)
하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 주기 계산 방식을 가진 계약만 조회합니다.
플랫폼 정산 기준일
(Optional)
하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 정산 기준일을 가진 계약만 조회합니다.
isArchived?: boolean
보관 조회 여부
(Optional)
true 이면 보관된 계약을 조회하고, false 이면 보관되지 않은 계약을 조회합니다. 기본값은 false 입니다.
검색 키워드 입력 정보
(Optional)
검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 계약만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.
Response
200
성공 응답으로 조회된 계약 리스트와 페이지 정보를 반환합니다.
조회된 계약 리스트
id: string
계약 고유 아이디
graphqlId: string
name: string
계약 이름
memo?: string
계약 내부 표기를 위한 메모
(Optional)
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
subtractPaymentVatAmount: boolean
정산 시 결제금액 부가세 감액 여부
false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.
isArchived: boolean
보관 여부
변경 적용 시점
반환된 페이지 결과 정보
반환된 페이지 결과 정보
number: integer (32 bit)
요청된 페이지 번호
size: integer (32 bit)
요청된 페이지 당 객체 수
totalCount: integer (32 bit)
실제 반환된 객체 수
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/contracts
계약 생성
새로운 계약을 생성합니다.
Request
Body
id?: string
계약에 부여할 고유 아이디
(Optional)
명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.
name: string
계약 이름
memo?: string
계약 내부 표기를 위한 메모
(Optional)
수수료 계산 방식을 특정하기 위한 입력 정보
정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다.
두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.
fixedRate?: integer (32 bit)
정률 수수료
(Optional)
fixedAmount?: integer (64 bit)
정액 수수료
(Optional)
플랫폼 정산 주기 입력 정보
플랫폼 정산 주기 입력 정보
lagDays: integer (32 bit)
지체일 (d+n 의 n)
정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다.
플랫폼 정산 기준일
플랫폼 정산 기준일
플랫폼 정산 주기 계산 방식 입력 정보
하나의 하위 필드에만 값을 명시하여 요청합니다.
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PARTNER파트너가 부담하는 경우MERCHANT고객사가 부담하는 경우subtractPaymentVatAmount: boolean
정산 시 결제금액 부가세 감액 여부
Response
200
성공 응답으로 생성된 계약 객체가 반환됩니다.
계약
계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.
id: string
계약 고유 아이디
graphqlId: string
name: string
계약 이름
memo?: string
계약 내부 표기를 위한 메모
(Optional)
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
subtractPaymentVatAmount: boolean
정산 시 결제금액 부가세 감액 여부
false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
409
PlatformContractAlreadyExistsError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformContractAlreadyExistsError 입니다.
message?: string
(Optional)
try
Request
Request Sample
get/platform/contracts/{id}
계약 조회
주어진 아이디에 대응되는 계약을 조회합니다.
Request
Path
id: string
조회할 계약 아이디
조회할 계약 아이디
Response
200
성공 응답으로 계약 객체를 반환합니다.
id: string
계약 고유 아이디
graphqlId: string
name: string
계약 이름
memo?: string
계약 내부 표기를 위한 메모
(Optional)
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformFixedAmountFee 입니다.
amount: integer (64 bit)
고정된 수수료 금액
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
lagDays: integer (32 bit)
지체일 (d+n 의 n)
정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다.
플랫폼 정산 기준일
플랫폼 정산 기준일
플랫폼 정산 주기 계산 방식
플랫폼 정산 주기 계산 방식
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PARTNER파트너가 부담하는 경우MERCHANT고객사가 부담하는 경우subtractPaymentVatAmount: boolean
정산 시 결제금액 부가세 감액 여부
false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformContractNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformContractNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
patch/platform/contracts/{id}
계약 수정
주어진 아이디에 대응되는 계약을 업데이트합니다.
Request
Path
id: string
업데이트할 계약 아이디
업데이트할 계약 아이디
Body
name?: string
계약 이름
(Optional)
memo?: string
계약 내부 표기를 위한 메모
(Optional)
수수료 계산 방식을 특정하기 위한 입력 정보
(Optional)
정률 수수료를 설정하고 싶은 경우 fixedRate 필드에, 정액 수수료를 설정하고 싶은 경우 fixedAmount 필드에 값을 명시해 요청합니다.
두 필드 모두 값이 들어있지 않은 경우 요청이 거절됩니다.
fixedRate?: integer (32 bit)
정률 수수료
(Optional)
fixedAmount?: integer (64 bit)
정액 수수료
(Optional)
플랫폼 정산 주기 입력 정보
(Optional)
플랫폼 정산 주기 입력 정보
lagDays: integer (32 bit)
지체일 (d+n 의 n)
정산시작일(통상 주문완료일)로부터 더해진 다음 날짜로부터 가장 가까운 날에 정산이 됩니다. 최소 1 에서 최대 10 까지 지정할 수 있습니다.
플랫폼 정산 기준일
플랫폼 정산 기준일
플랫폼 정산 주기 계산 방식 입력 정보
하나의 하위 필드에만 값을 명시하여 요청합니다.
금액 부담 주체
(Optional)
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
PARTNER파트너가 부담하는 경우MERCHANT고객사가 부담하는 경우subtractPaymentVatAmount?: boolean
정산 시 결제금액 부가세 감액 여부
(Optional)
Response
200
성공 응답으로 업데이트된 계약 객체가 반환됩니다.
계약
계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.
id: string
계약 고유 아이디
graphqlId: string
name: string
계약 이름
memo?: string
계약 내부 표기를 위한 메모
(Optional)
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
subtractPaymentVatAmount: boolean
정산 시 결제금액 부가세 감액 여부
false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformContractNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformContractNotFoundError 입니다.
message?: string
(Optional)
409
PlatformArchivedContractError: 보관된 계약을 업데이트하려고 하는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformArchivedContractError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/contracts/{id}/archive
계약 보관
주어진 아이디에 대응되는 계약을 보관합니다.
Request
Path
id: string
계약 아이디
계약 아이디
Response
200
성공 응답으로 보관된 계약 객체를 반환합니다.
계약
계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.
id: string
계약 고유 아이디
graphqlId: string
name: string
계약 이름
memo?: string
계약 내부 표기를 위한 메모
(Optional)
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
subtractPaymentVatAmount: boolean
정산 시 결제금액 부가세 감액 여부
false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformContractNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformContractNotFoundError 입니다.
message?: string
(Optional)
409
PlatformCannotArchiveScheduledContractError: 예약된 업데이트가 있는 계약을 보관하려고 하는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformCannotArchiveScheduledContractError 입니다.
message?: string
(Optional)
try
Request
Request Sample
post/platform/contracts/{id}/recover
계약 복원
주어진 아이디에 대응되는 계약을 복원합니다.
Request
Path
id: string
계약 아이디
계약 아이디
Response
200
성공 응답으로 복원된 계약 객체를 반환합니다.
계약
계약은 플랫폼 고객사가 파트너에게 정산해줄 대금과 정산일을 계산하는 데 적용되는 정보입니다. 고객사의 플랫폼에서 재화 및 서비스를 판매하기 위한 중개수수료와 판매금에 대한 정산일로 구성되어 있습니다.
id: string
계약 고유 아이디
graphqlId: string
name: string
계약 이름
memo?: string
계약 내부 표기를 위한 메모
(Optional)
플랫폼 중개수수료 정보
플랫폼 중개수수료 정보
정산 주기
지체일, 정산일, 기준일로 구성되며, 해당 요소들의 조합으로 실제 정산일을 계산합니다.
금액 부담 주체
플랫폼에서 발생한 결제 수수료, 부가세 등 금액을 부담하는 주체를 나타냅니다.
subtractPaymentVatAmount: boolean
정산 시 결제금액 부가세 감액 여부
false인 경우 정산금에서 결제 금액 부가세를 감액하지 않고, true인 경우 정산금에서 결제 금액 부가세를 감액합니다.
isArchived: boolean
보관 여부
변경 적용 시점
400
InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 InvalidRequestError 입니다.
message?: string
(Optional)
401
UnauthorizedError: 인증 정보가 올바르지 않은 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 UnauthorizedError 입니다.
message?: string
(Optional)
403
PlatformNotEnabledError: 플랫폼 기능이 활성화되지 않아 요청을 처리할 수 없는 경우ForbiddenError: 요청이 거절된 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 ForbiddenError 입니다.
message?: string
(Optional)
404
PlatformContractNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformContractNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
파트너 관련 API
정산 상세내역 관련 API
파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다.
계좌 관련 API
파트너 정산 서비스의 계좌와 관련된 API 입니다.
정산 내역 관련 API
파트너 정산 서비스의 정산 내역과 관련된 API 입니다.
지급 내역 관련 API
파트너 정산 서비스의 지급 내역과 관련된 API 입니다.
일괄 지급 내역 관련 API
파트너 정산 서비스의 일괄 지급 내역과 관련된 API 입니다.
이체 내역 관련 API
파트너 정산 서비스의 이체 내역과 관련된 API 입니다.
특정 PG사 관련 API
특정 PG사에 국한된 API 기능을 제공합니다.
대사 서비스 API
거래 대사 및 정산 대사 관련 API 기능을 제공합니다.
공통 API
공통 API 기능을 제공합니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
AddressAlreadyPaidErrorAlreadyPaidOrWaitingErrorAmountExceededTypeApplyEscrowLogisticsErrorApplyEscrowLogisticsResponseArchivePlatformAdditionalFeePolicyErrorArchivePlatformAdditionalFeePolicyResponseArchivePlatformContractErrorArchivePlatformContractResponseArchivePlatformDiscountSharePolicyErrorArchivePlatformDiscountSharePolicyResponseArchivePlatformPartnerErrorArchivePlatformPartnerResponseBankBankInfoBankInfoNameBeforeRegisteredPaymentEscrowBillingKeyAlreadyDeletedErrorBillingKeyFailureBillingKeyFilterInputBillingKeyInfoBillingKeyInfoSummaryBillingKeyNotFoundErrorBillingKeyNotIssuedErrorBillingKeyPaymentInputBillingKeyPaymentMethodBillingKeyPaymentMethodCardBillingKeyPaymentMethodEasyPayBillingKeyPaymentMethodEasyPayChargeBillingKeyPaymentMethodEasyPayMethodBillingKeyPaymentMethodMobileBillingKeyPaymentMethodPaypalBillingKeyPaymentMethodTransferBillingKeyPaymentMethodTypeBillingKeyPaymentSummaryBillingKeySortByBillingKeySortInputBillingKeyStatusBillingKeyTextSearchBillingKeyTextSearchFieldBillingKeyTimeRangeFieldCancelAmountExceedsCancellableAmountErrorCancelCashReceiptErrorCancelCashReceiptResponseCancelPaymentBodyRefundAccountCancelPaymentErrorCancelPaymentResponseCancelRequesterCancelTaxAmountExceedsCancellableTaxAmountErrorCancelTaxFreeAmountExceedsCancellableTaxFreeAmountErrorCancellableAmountConsistencyBrokenErrorCancelledCashReceiptCancelledPaymentCancelledPaymentCashReceiptCancelledPaymentEscrowCardCardBrandCardCredentialCardOwnerTypeCardPromotionCardTypeCashReceiptCashReceiptAlreadyIssuedErrorCashReceiptInputCashReceiptInputTypeCashReceiptNotFoundErrorCashReceiptNotIssuedErrorCashReceiptSummaryCashReceiptTypeChannelGroupSummaryChannelNotFoundErrorChannelSpecificErrorChannelSpecificFailureChannelSpecificFailureInvalidRequestChannelSpecificFailurePgProviderCloseVirtualAccountErrorCloseVirtualAccountResponseConfirmEscrowErrorConfirmEscrowResponseConfirmIdentityVerificationErrorConfirmIdentityVerificationResponseConfirmedPaymentEscrowCountryCreateManualTransferResponseCreateOrderCancelTransferResponseCreateOrderTransferResponseCreatePaymentScheduleErrorCreatePaymentScheduleResponseCreatePlatformAdditionalFeePolicyErrorCreatePlatformAdditionalFeePolicyResponseCreatePlatformContractErrorCreatePlatformContractResponseCreatePlatformDiscountSharePolicyErrorCreatePlatformDiscountSharePolicyResponseCreatePlatformManualTransferErrorCreatePlatformOrderCancelTransferBodyDiscountCreatePlatformOrderCancelTransferBodyExternalCancellationDetailCreatePlatformOrderCancelTransferBodyOrderDetailCreatePlatformOrderCancelTransferBodyOrderDetailAllCreatePlatformOrderCancelTransferBodyOrderLineCreatePlatformOrderCancelTransferErrorCreatePlatformOrderTransferBodyAdditionalFeeCreatePlatformOrderTransferBodyDiscountCreatePlatformOrderTransferBodyExternalPaymentDetailCreatePlatformOrderTransferBodyOrderDetailCreatePlatformOrderTransferBodyOrderLineCreatePlatformOrderTransferBodyProductCreatePlatformOrderTransferErrorCreatePlatformPartnerBodyCreatePlatformPartnerBodyAccountCreatePlatformPartnerBodyContactCreatePlatformPartnerBodyTypeCreatePlatformPartnerBodyTypeBusinessCreatePlatformPartnerBodyTypeNonWhtPayerCreatePlatformPartnerBodyTypeWhtPayerCreatePlatformPartnerErrorCreatePlatformPartnerResponseCreatePlatformPartnersErrorCreatePlatformPartnersResponseCurrencyCustomerCustomerInputCustomerNameInputCustomerSeparatedNameDateRangeDateTimeRangeDayOfWeekDeleteBillingKeyErrorDeleteBillingKeyResponseDeletePlatformTransferErrorDeletePlatformTransferResponseDeletedBillingKeyInfoDeliveredPaymentEscrowDiscountAmountExceedsTotalAmountErrorDownloadPlatformTransferSheetErrorEasyPayMethodTypeEasyPayProviderFailedIdentityVerificationFailedPaymentFailedPaymentCancellationFailedPaymentScheduleFailedPgBillingKeyIssueResponseForbiddenErrorGenderGetAllPaymentsByCursorResponseGetAllPaymentsErrorGetBankInfosErrorGetBankInfosResponseGetBillingKeyInfoErrorGetBillingKeyInfosErrorGetBillingKeyInfosResponseGetCashReceiptErrorGetIdentityVerificationErrorGetKakaopayPaymentOrderErrorGetKakaopayPaymentOrderResponseGetPaymentErrorGetPaymentScheduleErrorGetPaymentSchedulesErrorGetPaymentSchedulesResponseGetPaymentsErrorGetPaymentsResponseGetPlatformAccountHolderErrorGetPlatformAccountTransfersErrorGetPlatformAccountTransfersResponseGetPlatformAdditionalFeePoliciesErrorGetPlatformAdditionalFeePoliciesResponseGetPlatformAdditionalFeePolicyErrorGetPlatformBulkPayoutsErrorGetPlatformBulkPayoutsResponseGetPlatformContractErrorGetPlatformContractsErrorGetPlatformContractsResponseGetPlatformDiscountSharePoliciesErrorGetPlatformDiscountSharePoliciesResponseGetPlatformDiscountSharePolicyErrorGetPlatformPartnerErrorGetPlatformPartnerSettlementsErrorGetPlatformPartnerSettlementsResponseGetPlatformPartnersErrorGetPlatformPartnersResponseGetPlatformPayoutsErrorGetPlatformPayoutsResponseGetPlatformTransferErrorGetPlatformTransferSummariesErrorGetPlatformTransferSummariesResponseGetPromotionErrorIdentityVerificationIdentityVerificationAlreadySentErrorIdentityVerificationAlreadyVerifiedErrorIdentityVerificationFailureIdentityVerificationMethodIdentityVerificationNotFoundErrorIdentityVerificationNotSentErrorIdentityVerificationOperatorIdentityVerificationRequestedCustomerIdentityVerificationVerifiedCustomerInstantBillingKeyPaymentMethodInputInstantBillingKeyPaymentMethodInputCardInstantPaymentMethodInputInstantPaymentMethodInputCardInstantPaymentMethodInputVirtualAccountInstantPaymentMethodInputVirtualAccountCashReceiptInfoInstantPaymentMethodInputVirtualAccountExpiryInstantPaymentMethodInputVirtualAccountOptionInstantPaymentMethodInputVirtualAccountOptionFixedInstantPaymentMethodInputVirtualAccountOptionTypeInstantPaymentSummaryInvalidRequestErrorIssueBillingKeyErrorIssueBillingKeyResponseIssueCashReceiptCustomerInputIssueCashReceiptErrorIssueCashReceiptResponseIssueFailedCashReceiptIssuedBillingKeyInfoIssuedCashReceiptIssuedPaymentCashReceiptIssuedPgBillingKeyIssueResponseLoginViaApiSecretErrorLoginViaApiSecretResponseMaxTransactionCountReachedErrorMaxWebhookRetryCountReachedErrorModifyEscrowLogisticsErrorModifyEscrowLogisticsResponseMonthDayNegativePromotionAdjustedCancelAmountErrorOneLineAddressPageInfoPageInputPaidPaymentPartialCancelledPaymentPayInstantlyErrorPayInstantlyResponsePayPendingPaymentPayWithBillingKeyErrorPayWithBillingKeyResponsePaymentPaymentAlreadyCancelledErrorPaymentAmountPaymentAmountInputPaymentCancellationPaymentCashReceiptPaymentCashReceiptStatusPaymentClientTypePaymentEscrowPaymentEscrowReceiverInputPaymentEscrowSenderInputPaymentFailurePaymentFilterInputPaymentFilterInputEscrowStatusPaymentInstallmentPaymentLogisticsPaymentLogisticsCompanyPaymentMethodPaymentMethodCardPaymentMethodEasyPayPaymentMethodEasyPayMethodPaymentMethodEasyPayMethodChargePaymentMethodGiftCertificatePaymentMethodGiftCertificateTypePaymentMethodMobilePaymentMethodTransferPaymentMethodTypePaymentMethodVirtualAccountPaymentMethodVirtualAccountRefundStatusPaymentMethodVirtualAccountTypePaymentNotFoundErrorPaymentNotPaidErrorPaymentNotWaitingForDepositErrorPaymentProductPaymentProductTypePaymentSchedulePaymentScheduleAlreadyExistsErrorPaymentScheduleAlreadyProcessedErrorPaymentScheduleAlreadyRevokedErrorPaymentScheduleFilterInputPaymentScheduleNotFoundErrorPaymentScheduleSortByPaymentScheduleSortInputPaymentScheduleStatusPaymentScheduleSummaryPaymentSortByPaymentStatusPaymentTextSearchPaymentTextSearchFieldPaymentTimestampTypePaymentWebhookPaymentWebhookPaymentStatusPaymentWebhookRequestPaymentWebhookResponsePaymentWebhookStatusPaymentWebhookTriggerPaymentWithCursorPendingPaymentSchedulePgBillingKeyIssueResponsePgCompanyPgProviderPgProviderErrorPlatformAccountPlatformAccountHolderPlatformAccountStatusPlatformAccountTransferPlatformAccountTransferFilterPlatformAccountTransferTypePlatformAccountVerificationAlreadyUsedErrorPlatformAccountVerificationFailedErrorPlatformAccountVerificationNotFoundErrorPlatformAdditionalFeePoliciesNotFoundErrorPlatformAdditionalFeePolicyPlatformAdditionalFeePolicyAlreadyExistsErrorPlatformAdditionalFeePolicyFilterInputPlatformAdditionalFeePolicyFilterInputKeywordPlatformAdditionalFeePolicyNotFoundErrorPlatformAdditionalFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformArchivedAdditionalFeePolicyErrorPlatformArchivedContractErrorPlatformArchivedDiscountSharePolicyErrorPlatformArchivedPartnerErrorPlatformBulkPayoutPlatformBulkPayoutFilterInputPlatformBulkPayoutFilterInputCriteriaPlatformBulkPayoutStatsPlatformBulkPayoutStatusPlatformBulkPayoutStatusStatsPlatformCancelOrderTransfersExistsErrorPlatformCancellableAmountExceededErrorPlatformCancellableAmountTypePlatformCancellableDiscountAmountExceededErrorPlatformCancellableDiscountTaxFreeAmountExceededErrorPlatformCancellableProductQuantityExceededErrorPlatformCancellationAndPaymentTypeMismatchedErrorPlatformCancellationNotFoundErrorPlatformCannotArchiveScheduledAdditionalFeePolicyErrorPlatformCannotArchiveScheduledContractErrorPlatformCannotArchiveScheduledDiscountSharePolicyErrorPlatformCannotArchiveScheduledPartnerErrorPlatformCannotSpecifyTransferErrorPlatformConnectedPartnerBrnUnchangeableErrorPlatformConnectedPartnerTypeUnchangeableErrorPlatformContactPlatformContractPlatformContractAlreadyExistsErrorPlatformContractFilterInputPlatformContractFilterInputKeywordPlatformContractNotFoundErrorPlatformContractPlatformFixedAmountFeeCurrencyAndSettlementCurrencyMismatchedErrorPlatformContractsNotFoundErrorPlatformCurrencyNotSupportedErrorPlatformDepositAccountTransferPlatformDiscountSharePoliciesNotFoundErrorPlatformDiscountSharePolicyPlatformDiscountSharePolicyAlreadyExistsErrorPlatformDiscountSharePolicyFilterInputPlatformDiscountSharePolicyFilterInputKeywordPlatformDiscountSharePolicyIdDuplicatedErrorPlatformDiscountSharePolicyNotFoundErrorPlatformExternalApiFailedErrorPlatformExternalApiTemporarilyFailedErrorPlatformExternalPaymentPlatformFeePlatformFeeInputPlatformFixedAmountFeePlatformFixedRateFeePlatformInsufficientDataToChangePartnerTypeErrorPlatformManualTransferPlatformManualTransferSummaryPlatformNotEnabledErrorPlatformNotSupportedBankErrorPlatformOrderCancelTransferPlatformOrderCancelTransferSummaryPlatformOrderDetailMismatchedErrorPlatformOrderSettlementAmountPlatformOrderTransferPlatformOrderTransferAdditionalFeePlatformOrderTransferAlreadyCancelledErrorPlatformOrderTransferCancellationPlatformOrderTransferDiscountPlatformOrderTransferOrderLinePlatformOrderTransferProductPlatformOrderTransferSummaryPlatformPartnerPlatformPartnerBusinessStatusPlatformPartnerFilterInputPlatformPartnerFilterInputKeywordPlatformPartnerIdAlreadyExistsErrorPlatformPartnerIdsAlreadyExistErrorPlatformPartnerIdsDuplicatedErrorPlatformPartnerManualSettlementPlatformPartnerMemberCompanyConnectionStatusPlatformPartnerNotFoundErrorPlatformPartnerOrderCancelSettlementPlatformPartnerOrderSettlementPlatformPartnerPayoutAccountTransferPlatformPartnerSettlementPlatformPartnerSettlementFilterInputPlatformPartnerSettlementFilterKeywordInputPlatformPartnerSettlementStatusPlatformPartnerSettlementStatusStatsPlatformPartnerSettlementTypePlatformPartnerStatusPlatformPartnerTaxationTypePlatformPartnerTypePlatformPartnerTypeBusinessPlatformPartnerTypeNamePlatformPartnerTypeNonWhtPayerPlatformPartnerTypeWhtPayerPlatformPayerPlatformPaymentPlatformPaymentMethodPlatformPaymentMethodCardPlatformPaymentMethodCardInputPlatformPaymentMethodEasyPayPlatformPaymentMethodEasyPayInputPlatformPaymentMethodGiftCertificatePlatformPaymentMethodGiftCertificateInputPlatformPaymentMethodInputPlatformPaymentMethodMobilePlatformPaymentMethodMobileInputPlatformPaymentMethodTransferPlatformPaymentMethodTransferInputPlatformPaymentMethodVirtualAccountPlatformPaymentMethodVirtualAccountInputPlatformPaymentNotFoundErrorPlatformPayoutPlatformPayoutAccountPlatformPayoutFilterInputPlatformPayoutFilterInputCriteriaPlatformPayoutMethodPlatformPayoutStatusPlatformPayoutStatusStatsPlatformPortOnePaymentPlatformPortOnePaymentCancelAmountTypePlatformProductIdDuplicatedErrorPlatformProductIdNotFoundErrorPlatformPropertiesPlatformRemitAccountTransferPlatformSettlementAmountExceededErrorPlatformSettlementCancelAmountExceededPortOneCancelErrorPlatformSettlementCyclePlatformSettlementCycleDatePolicyPlatformSettlementCycleInputPlatformSettlementCycleMethodPlatformSettlementCycleMethodDailyPlatformSettlementCycleMethodDailyInputPlatformSettlementCycleMethodInputPlatformSettlementCycleMethodManualDatesPlatformSettlementCycleMethodManualDatesInputPlatformSettlementCycleMethodMonthlyPlatformSettlementCycleMethodMonthlyInputPlatformSettlementCycleMethodWeeklyPlatformSettlementCycleMethodWeeklyInputPlatformSettlementCycleTypePlatformSettlementParameterNotFoundErrorPlatformSettlementParameterValuePlatformSettlementPaymentAmountExceededPortOnePaymentErrorPlatformSettlementSupplyWithVatAmountExceededPortOnePaymentErrorPlatformSettlementTaxFreeAmountExceededPortOnePaymentErrorPlatformTransferPlatformTransferAlreadyExistsErrorPlatformTransferDiscountSharePolicyNotFoundErrorPlatformTransferFilterInputPlatformTransferFilterInputKeywordPlatformTransferNonDeletableStatusErrorPlatformTransferNotFoundErrorPlatformTransferSheetFieldPlatformTransferStatusPlatformTransferSummaryPlatformTransferSummaryExternalPaymentPlatformTransferSummaryPartnerPlatformTransferSummaryPartnerTypePlatformTransferSummaryPaymentPlatformTransferSummaryPortOnePaymentPlatformTransferTypePlatformUserDefinedPropertyKeyValuePlatformUserDefinedPropertyNotFoundErrorPlatformUserDefinedPropertyValuePortOneVersionPreRegisterPaymentErrorPreRegisterPaymentResponsePromotionPromotionAmountDiscountSchemePromotionCardCompanyPromotionDiscountPartitionPromotionDiscountPolicyPromotionDiscountRetainOptionPromotionDiscountRetainOptionShouldNotBeChangedErrorPromotionDiscountSchemePromotionNotFoundErrorPromotionPayMethodDoesNotMatchErrorPromotionPercentDiscountSchemePromotionRecoverOptionPromotionRecoverOptionNoRecoverPromotionRecoverOptionRecoverPromotionSpareBudgetPromotionSpareBudgetAmountPromotionSpareBudgetPercentPromotionStatusReadyIdentityVerificationReadyPaymentRecoverPlatformAdditionalFeePolicyErrorRecoverPlatformAdditionalFeePolicyResponseRecoverPlatformContractErrorRecoverPlatformContractResponseRecoverPlatformDiscountSharePolicyErrorRecoverPlatformDiscountSharePolicyResponseRecoverPlatformPartnerErrorRecoverPlatformPartnerResponseRefreshTokenErrorRefreshTokenResponseRegisterStoreReceiptBodyItemRegisterStoreReceiptErrorRegisterStoreReceiptResponseRegisteredPaymentEscrowRejectConfirmedPaymentEscrowRejectedPaymentEscrowRequestedPaymentCancellationResendIdentityVerificationErrorResendIdentityVerificationResponseResendWebhookErrorResendWebhookResponseRevokePaymentSchedulesErrorRevokePaymentSchedulesResponseRevokedPaymentScheduleScheduledPaymentScheduleSelectedChannelSelectedChannelTypeSendIdentityVerificationBodyCustomerSendIdentityVerificationErrorSendIdentityVerificationResponseSeparatedAddressSeparatedAddressInputSortOrderStartedPaymentScheduleSucceededPaymentCancellationSucceededPaymentScheduleSumOfPartsExceedsCancelAmountErrorSumOfPartsExceedsTotalAmountErrorTransferParametersTriggerUnauthorizedErrorUpdatePlatformAdditionalFeePolicyErrorUpdatePlatformAdditionalFeePolicyResponseUpdatePlatformContractErrorUpdatePlatformContractResponseUpdatePlatformDiscountSharePolicyErrorUpdatePlatformDiscountSharePolicyResponseUpdatePlatformPartnerBodyAccountUpdatePlatformPartnerBodyContactUpdatePlatformPartnerBodyTypeUpdatePlatformPartnerBodyTypeBusinessUpdatePlatformPartnerBodyTypeNonWhtPayerUpdatePlatformPartnerBodyTypeWhtPayerUpdatePlatformPartnerErrorUpdatePlatformPartnerResponseVerifiedIdentityVerificationVirtualAccountIssuedPaymentWebhookNotFoundError