개발자센터

PortOne REST API - V2

API 결제, 결제 정보 조회, 결제 취소 등의 기능을 제공하는 REST API입니다.

V2 API hostname: api.portone.io

OpenAPI JSON 내려받기Postman 등에서 import하여 활용할 수 있습니다.

요청 및 응답 형식

요청과 응답의 본문은 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에 대해 아래와 같은 하위호환성이 보장됩니다.

  1. 현재 사용 가능한 입력 형식은 앞으로도 사용할 수 있습니다.

    • 입력 형식 내 필드 정의가 삭제되지 않습니다.

    • 필수 입력 정보가 추가되거나, 선택 입력 정보가 필수로 변경되지 않습니다.

      • 오로지 선택 입력 정보만 추가될 수 있습니다.
    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.
    • enum 타입의 값이 삭제되지 않습니다.

  2. 출력 형식이 확장될 수 있지만, 축소되지 않습니다.

    • 출력 형식 내 필드 정의가 삭제되지 않습니다.

    • 사용 중인 필수 출력 정보가 선택사항으로 변경되거나 출력 시 누락되지 않습니다.

      • 이미 존재하는 용례 내에서는 필수 출력 정보가 언제나 유지됩니다.
      • 단, 기능이 추가 및 확장되는 등 새로운 용례로 사용될 때의 출력 정보에 한하여 선택사항으로 변경될 수 있습니다.
    • 하위 필드의 형식(타입) 또한 위 규칙을 지키며 변경됩니다.

    • 단, 새로운 필드 또는 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 기능을 제공합니다.

파트너 정산 관련 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}/recover

파트너 관련 API

파트너 정산에 적용할 파트너에 관한 API 입니다.
get/platform/partners

파트너 다건 조회

여러 파트너를 조회합니다.

Request

Query

requestBody?:
(Optional)

Response

200

성공 응답으로 조회된 파트너 리스트와 페이지 정보가 반환됩니다.

items: PlatformPartner[]
조회된 파트너 리스트
id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties
page: PageInfo
반환된 페이지 결과 정보

반환된 페이지 결과 정보

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
N/A
post/platform/partners

파트너 생성

새로운 파트너를 생성합니다.

Request

Body

id?: string
파트너에 부여할 고유 아이디
(Optional)

고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

name: string
파트너 법인명 혹은 이름
contact: CreatePlatformPartnerBodyContact
파트너 담당자 정보

파트너 담당자 정보

name: string
담당자 이름
phoneNumber?: string
담당자 휴대폰 번호
(Optional)
email: string
담당자 이메일
account: CreatePlatformPartnerBodyAccount
파트너 계좌 등록을 위한 정보

파트너 계좌 등록을 위한 정보

bank: Bank
은행

은행

currency: Currency
통화 단위

통화 단위

number: string
계좌번호
holder: string
예금주명
accountVerificationId?: string
계좌 검증 아이디
(Optional)
defaultContractId: string
기본 계약 아이디

이미 존재하는 계약 아이디를 등록해야 합니다.

memo?: string
파트너에 대한 메모
(Optional)

총 256자까지 입력할 수 있습니다.

tags: string[]
파트너에 부여할 태그 리스트

최대 10개까지 입력할 수 있습니다.

type: CreatePlatformPartnerBodyType
파트너 생성을 위한 유형별 추가 정보

파트너 생성을 위한 유형별 추가 정보

business?: CreatePlatformPartnerBodyTypeBusiness
CreatePlatformPartnerBodyTypeBusiness
(Optional)
whtPayer?: CreatePlatformPartnerBodyTypeWhtPayer
CreatePlatformPartnerBodyTypeWhtPayer
(Optional)
nonWhtPayer?: CreatePlatformPartnerBodyTypeNonWhtPayer
CreatePlatformPartnerBodyTypeNonWhtPayer
(Optional)
userDefinedProperties?: PlatformProperties
PlatformProperties
(Optional)
[key: string]?: PlatformUserDefinedPropertyValue
PlatformUserDefinedPropertyValue
(Optional)

Response

200

성공 응답으로 생성된 파트너 객체가 반환됩니다.

partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
  • PlatformAccountVerificationFailedError: 파트너 계좌 인증이 실패한 경우
  • PlatformCurrencyNotSupportedError: 지원 되지 않는 통화를 선택한 경우
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
  • PlatformAccountVerificationNotFoundError: 파트너 계좌 검증 아이디를 찾을 수 없는 경우
  • PlatformUserDefinedPropertyNotFoundError: 사용자 정의 속성이 존재 하지 않는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAccountVerificationNotFoundError 입니다.
message?: string
(Optional)

409

  • PlatformPartnerIdAlreadyExistsError
  • PlatformAccountVerificationAlreadyUsedError: 파트너 계좌 검증 아이디를 이미 사용한 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAccountVerificationAlreadyUsedError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
get/platform/partners/{id}

파트너 조회

파트너 객체를 조회합니다.

Request

Path

id: string
조회하고 싶은 파트너 아이디

조회하고 싶은 파트너 아이디

Response

200

성공 응답으로 파트너 객체가 반환됩니다.

id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

name: string
담당자 이름
phoneNumber?: string
담당자 휴대폰 번호
(Optional)
email: string
담당자 이메일
account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

bank: Bank
은행

은행

currency: Currency
통화 단위

통화 단위

number: string
계좌번호
holder: string
예금주명
status: PlatformAccountStatus
플랫폼 계좌 상태

플랫폼 계좌 상태

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

PENDING승인 대기 중
APPROVED승인 완료
REJECTED승인 거절
defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformPartnerTypeBusiness 입니다.
companyName: string
상호명
taxationType: PlatformPartnerTaxationType
플랫폼 파트너 과세 유형

플랫폼 파트너 과세 유형

businessStatus: PlatformPartnerBusinessStatus
플랫폼 파트너 사업자 상태

플랫폼 파트너 사업자 상태

businessRegistrationNumber: string
사업자등록번호
representativeName: string
대표자 이름
companyAddress?: string
사업장 주소
(Optional)
businessType?: string
업태
(Optional)
businessClass?: string
업종
(Optional)
memberCompanyConnectionStatus: PlatformPartnerMemberCompanyConnectionStatus
플랫폼 파트너 연동 사업자 연결 상태

플랫폼 파트너 연동 사업자 연결 상태

memberCompanyConnectionFailedReason?: string
연동사업자 연동 실패 사유
(Optional)
isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties
[key: string]?: PlatformUserDefinedPropertyValue
PlatformUserDefinedPropertyValue
(Optional)

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

  • PlatformPartnerNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformPartnerNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
patch/platform/partners/{id}

파트너 수정

주어진 아이디에 대응되는 파트너 정보를 업데이트합니다.

Request

Path

id: string
업데이트할 파트너 아이디

업데이트할 파트너 아이디

Body

name?: string
파트너 법인명 혹은 이름
(Optional)
contact?: UpdatePlatformPartnerBodyContact
파트너 담당자 업데이트를 위한 정보
(Optional)

파트너 담당자 업데이트를 위한 정보

name?: string
담당자 이름
(Optional)
phoneNumber?: string
담당자 휴대폰 번호
(Optional)
email?: string
담당자 이메일
(Optional)
account?: UpdatePlatformPartnerBodyAccount
파트너 계좌 업데이트를 위한 입력 정보
(Optional)

파트너 계좌 업데이트를 위한 입력 정보

bank: Bank
은행

은행

currency: Currency
통화 단위

통화 단위

number: string
계좌번호
holder: string
예금주명
accountVerificationId?: string
계좌 검증 아이디
(Optional)
defaultContractId?: string
파트너에 설정된 기본 계약 아이디
(Optional)
memo?: string
파트너에 대한 메모
(Optional)
tags?: string[]
파트너의 태그 리스트
(Optional)
type?: UpdatePlatformPartnerBodyType
파트너 업데이트를 위한 유형별 추가 정보
(Optional)

파트너 유형별 추가 정보를 수정합니다. 기존과 다른 파트너 유형 정보가 입력된 경우, 파트너의 유형 자체가 변경됩니다.

business?: UpdatePlatformPartnerBodyTypeBusiness
UpdatePlatformPartnerBodyTypeBusiness
(Optional)
whtPayer?: UpdatePlatformPartnerBodyTypeWhtPayer
UpdatePlatformPartnerBodyTypeWhtPayer
(Optional)
nonWhtPayer?: UpdatePlatformPartnerBodyTypeNonWhtPayer
UpdatePlatformPartnerBodyTypeNonWhtPayer
(Optional)
userDefinedProperties?: PlatformProperties
PlatformProperties
(Optional)
[key: string]?: PlatformUserDefinedPropertyValue
PlatformUserDefinedPropertyValue
(Optional)

Response

200

성공 응답으로 업데이트된 파트너 객체가 반환됩니다.

partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
  • PlatformAccountVerificationFailedError: 파트너 계좌 인증이 실패한 경우
  • PlatformInsufficientDataToChangePartnerTypeError: 파트너 타입 수정에 필요한 데이터가 부족한 경우
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

  • PlatformPartnerNotFoundError
  • PlatformContractNotFoundError
  • PlatformAccountVerificationNotFoundError: 파트너 계좌 검증 아이디를 찾을 수 없는 경우
  • PlatformUserDefinedPropertyNotFoundError: 사용자 정의 속성이 존재 하지 않는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAccountVerificationNotFoundError 입니다.
message?: string
(Optional)

409

  • PlatformArchivedPartnerError: 보관된 파트너를 업데이트하려고 하는 경우
  • PlatformAccountVerificationAlreadyUsedError: 파트너 계좌 검증 아이디를 이미 사용한 경우
  • PlatformConnectedPartnerBrnUnchangeableError: 연동 사업자로 연동된 파트너의 사업자등록번호를 변경하려고 시도한 경우
  • PlatformConnectedPartnerTypeUnchangeableError: 연동 사업자로 연동된 파트너의 파트너 유형을 변경하려고 시도한 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAccountVerificationAlreadyUsedError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
post/platform/partners/batch

파트너 다건 생성

새로운 파트너를 다건 생성합니다.

Request

Body

partners: CreatePlatformPartnerBody[]
생성할 파트너 리스트 정보
id?: string
파트너에 부여할 고유 아이디
(Optional)

고객사 서버에 등록된 파트너 지칭 아이디와 동일하게 설정하는 것을 권장합니다. 명시하지 않는 경우 포트원이 임의의 아이디를 발급해드립니다.

name: string
파트너 법인명 혹은 이름
contact: CreatePlatformPartnerBodyContact
파트너 담당자 정보

파트너 담당자 정보

account: CreatePlatformPartnerBodyAccount
파트너 계좌 등록을 위한 정보

파트너 계좌 등록을 위한 정보

defaultContractId: string
기본 계약 아이디

이미 존재하는 계약 아이디를 등록해야 합니다.

memo?: string
파트너에 대한 메모
(Optional)

총 256자까지 입력할 수 있습니다.

tags: string[]
파트너에 부여할 태그 리스트

최대 10개까지 입력할 수 있습니다.

type: CreatePlatformPartnerBodyType
파트너 생성을 위한 유형별 추가 정보

파트너 생성을 위한 유형별 추가 정보

userDefinedProperties?: PlatformProperties
PlatformProperties
(Optional)

Response

200

성공 응답

partners: PlatformPartner[]
생성된 파트너 리스트
id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties

400

  • InvalidRequestError: 요청된 입력 정보가 유효하지 않은 경우
  • PlatformPartnerIdsDuplicatedError
  • PlatformCurrencyNotSupportedError: 지원 되지 않는 통화를 선택한 경우
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

  • PlatformContractsNotFoundError
  • PlatformUserDefinedPropertyNotFoundError: 사용자 정의 속성이 존재 하지 않는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformContractsNotFoundError 입니다.
ids: string[]
graphqlIds: string[]
message?: string
(Optional)

409

  • PlatformPartnerIdsAlreadyExistError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformPartnerIdsAlreadyExistError 입니다.
ids: string[]
graphqlIds: string[]
message?: string
(Optional)
try
Request
Request Sample
N/A
post/platform/partners/{id}/archive

파트너 복원

주어진 아이디에 대응되는 파트너를 보관합니다.

Request

Path

id: string
파트너 아이디

파트너 아이디

Response

200

성공 응답으로 보관된 파트너 객체를 반환합니다.

partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties

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

  • PlatformPartnerNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformPartnerNotFoundError 입니다.
message?: string
(Optional)

409

  • PlatformCannotArchiveScheduledPartnerError: 예약된 업데이트가 있는 파트너를 보관하려고 하는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformCannotArchiveScheduledPartnerError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
post/platform/partners/{id}/recover

파트너 복원

주어진 아이디에 대응되는 파트너를 복원합니다.

Request

Path

id: string
파트너 아이디

파트너 아이디

Response

200

성공 응답으로 복원된 파트너 객체를 반환합니다.

partner: PlatformPartner
파트너

파트너는 고객사가 정산해주어야 할 대상입니다. 기본 사업자 정보와 정산정보, 그리고 적용될 계약의 정보를 등록 및 관리할 수 있습니다.

id: string
파트너 고유 아이디
graphqlId: string
name: string
파트너 법인명 혹은 이름
contact: PlatformContact
플랫폼 파트너 담당자 연락 정보

파트너 담당자에게 연락하기 위한 정보들 입니다.

account: PlatformAccount
플랫폼 정산 계좌

currency 가 KRW 일 경우 예금주 조회 API 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

status: PlatformPartnerStatus
플랫폼 파트너 상태

플랫폼 파트너 상태

defaultContractId: string
파트너에 설정된 기본 계약 아이디
memo?: string
파트너에 대한 메모
(Optional)
tags: string[]
파트너의 태그 리스트
type: PlatformPartnerType
파트너 유형별 추가 정보

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
userDefinedProperties: PlatformProperties
PlatformProperties

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

  • PlatformPartnerNotFoundError
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformPartnerNotFoundError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A

정산 상세내역 관련 API

파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다.

계좌 관련 API

파트너 정산 서비스의 계좌와 관련된 API 입니다.

정산 내역 관련 API

파트너 정산 서비스의 정산 내역과 관련된 API 입니다.

지급 내역 관련 API

파트너 정산 서비스의 지급 내역과 관련된 API 입니다.

일괄 지급 내역 관련 API

파트너 정산 서비스의 일괄 지급 내역과 관련된 API 입니다.

이체 내역 관련 API

파트너 정산 서비스의 이체 내역과 관련된 API 입니다.

특정 PG사 관련 API

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

대사 서비스 API

거래 대사 및 정산 대사 관련 API 기능을 제공합니다.

공통 API

공통 API 기능을 제공합니다.

타입 정의

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