개발자센터
V1
V2
파트너 정산 릴리즈 노트 기술 블로그

PortOne REST API - V2

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

V2 API hostname: api.portone.io

요청 및 응답 형식

요청과 응답의 본문은 JSON 형식입니다.
API 응답에 포함된 필드는 별도 안내 없이 추가될 수 있으니, 알지 못하는 필드가 있는 경우에는 무시하도록 개발해 주세요.

API 매개 변수 중 URL 경로에 들어가는 문자열 값이 있는 경우, URL 경로에 들어갈 수 없는 문자열은 이스케이프하여야 합니다. 자바스크립트의 encodeURIComponent 함수 등을 사용할 수 있습니다.

인증 방식

V2 API를 사용하기 위해서는 V2 API Secret이 필요하며, 포트원 콘솔 내 결제연동 탭에서 발급받을 수 있습니다.

인증 관련 API를 제외한 모든 API는 HTTP Authorization 헤더로 인증 정보를 전달해 주셔야 합니다. Authorization 헤더에 전달하는 형식은 두 가지 중 하나입니다.

  • API Secret 직접 사용 (간편)
    Authorization: PortOne MY_API_SECRET
  • 액세스 토큰 사용
    Authorization: Bearer MY_ACCESS_TOKEN
액세스 토큰을 사용한 인증을 원하는 경우, 인증 관련 API를 이용해 주세요.

GET 요청 시 Body 대신 Query 사용

GET 요청 시에 Body를 사용해야 하는 경우, Body 대신 Query를 사용할 수 있습니다.

이 경우, Body 객체를 requestBody Query 필드에 넣어주시면 됩니다.


인증 관련 API

결제 관련 API

결제 예약 관련 API

빌링키 관련 API

현금 영수증 관련 API

본인인증 관련 API

B2B 서비스 API

B2B 관련 API 기능을 제공합니다. alpha 버전의 API 로서, 사용을 원하실 경우 관리자콘솔 및 홈페이지를 통해 문의해주세요.

목차

연동 사업자 조회
get/b2b-preview/member-companies/{brn}
연동 사업자 정보 수정
patch/b2b-preview/member-companies/{brn}
사업자 연동
post/b2b-preview/member-companies
담당자 조회
get/b2b-preview/member-companies/{brn}/contacts/{contactId}
담당자 정보 수정
patch/b2b-preview/member-companies/{brn}/contacts/{contactId}
사업자 인증서 등록 URL 조회
get/b2b-preview/member-companies/{brn}/certificate/registration-url
인증서 조회
get/b2b-preview/member-companies/{brn}/certificate
담당자 ID 존재 여부 확인
get/b2b-preview/member-companies/contacts/id-existence
예금주 조회
get/b2b-preview/bank-accounts/{bank}/{accountNumber}/holder
사업자 상태 조회
get/b2b-preview/company/{brn}/state
세금계산서 역발행 요청
post/b2b-preview/tax-invoices/request-reverse-issuance
세금 계산서 조회
get/b2b-preview/tax-invoices/{documentKey}
세금계산서 삭제
delete/b2b-preview/tax-invoices/{documentKey}
세금계산서 발행
post/b2b-preview/tax-invoices/issue
세금계산서 역발행 요청 취소
post/b2b-preview/tax-invoices/cancel-request
세금계산서 역발행 취소
post/b2b-preview/tax-invoices/cancel-issuance
세금계산서 역발행 요청 거부
post/b2b-preview/tax-invoices/refuse-request
세금 계산서 다건조회
get/b2b-preview/tax-invoices
세금 계산서 팝업 URL 조회
get/b2b-preview/tax-invoices/{documentKey}/popup-url
세금 계산서 프린트 URL 조회
get/b2b-preview/tax-invoices/{documentKey}/print-url
세금 계산서 PDF 다운로드 URL 조회
get/b2b-preview/tax-invoices/{documentKey}/pdf-download-url
세금계산서 임시 저장
post/b2b-preview/tax-invoices/register
세금계산서 역발행 요청
post/b2b-preview/tax-invoices/request
세금계산서 파일 업로드 링크 생성
post/b2b-preview/tax-invoices/file-upload-link
세금계산서 파일 첨부
post/b2b-preview/tax-invoices/attach-file
세금계산서 첨부파일 목록 조회
get/b2b-preview/tax-invoices/{documentKey}/attachments
세금계산서 첨부파일 삭제
delete/b2b-preview/tax-invoices/{documentKey}/attachments/{attachmentId}

파트너 정산 관련 API

파트너 정산 서비스 API 기능을 제공합니다.


정책 관련 API

파트너 관련 API

get/platform/partners

파트너 다건 조회

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

Request

body를 쿼리 문자열에 포함시켜 보낼 수 있습니다. 자세히 보기

Body

page?: PageInput
다건 조회 API 에 사용되는 페이지 입력 정보
(Optional)

다건 조회 API 에 사용되는 페이지 입력 정보

number?: integer (32 bit)
0부터 시작하는 페이지 번호
(Optional)
size?: integer (32 bit)
각 페이지 당 포함할 객체 수
(Optional)

파트너 필터 입력 정보
(Optional)

파트너 필터 입력 정보

isArchived?: boolean
보관 조회 여부
(Optional)

true 이면 보관된 파트너를 조회하고, false 이면 보관되지 않은 파트너를 조회합니다. 기본값은 false 입니다.

tags?: string[]
(Optional)

하나 이상의 값이 존재하는 경우 해당 리스트에 포함되는 태그를 하나 이상 가지는 파트너만 조회합니다.

banks?: Bank[]
은행
(Optional)

하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 계좌 은행을 가진 파트너만 조회합니다.

accountCurrencies?: Currency[]
통화 단위
(Optional)

하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 계좌 통화를 가진 파트너만 조회합니다.

ids?: string[]
(Optional)

하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 아이디를 가진 파트너만 조회합니다.

contractIds?: string[]
(Optional)

하나 이상의 값이 존재하는 경우, 해당 리스트에 포함되는 기본 계약 id를 가진 파트너만 조회합니다.

파트너 검색 키워드 입력 정보
(Optional)

검색 키워드 적용을 위한 옵션으로, 명시된 키워드를 포함하는 파트너만 조회합니다. 하나의 하위 필드에만 값을 명시하여 요청합니다.

Response

200

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

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

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

account: PlatformAccount
플랫폼 정산 계좌

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

플랫폼 파트너 상태

플랫폼 파트너 상태

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

파트너 유형별 추가 정보

isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점
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
파트너 법인명 혹은 이름

파트너 담당자 정보

파트너 담당자 정보

name: string
담당자 이름
phoneNumber?: string
담당자 휴대폰 번호
(Optional)
email: string
담당자 이메일

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

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

bank: Bank
은행

은행

currency: Currency
통화 단위

통화 단위

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

defaultContractId: string
기본 계약 아이디

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


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

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


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

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


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

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

Response

200

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

partner: PlatformPartner
파트너

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

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

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

account: PlatformAccount
플랫폼 정산 계좌

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

플랫폼 파트너 상태

플랫폼 파트너 상태

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

파트너 유형별 추가 정보

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

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: 파트너 계좌 검증 아이디를 찾을 수 없는 경우
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
예금주명
플랫폼 계좌 상태

플랫폼 계좌 상태

플랫폼 파트너 상태

플랫폼 파트너 상태

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

파트너 유형별 추가 정보

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

플랫폼 파트너 과세 유형

플랫폼 파트너 사업자 상태

플랫폼 파트너 사업자 상태

businessRegistrationNumber: string
사업자등록번호
representativeName: string
대표자 이름
companyAddress?: string
사업장 주소
(Optional)
businessType?: string
업태
(Optional)
businessClass?: string
업종
(Optional)
isArchived: boolean
보관 여부
appliedAt: string (RFC 3339 date-time)
변경 적용 시점

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)

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

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

name?: string
담당자 이름
(Optional)
phoneNumber?: string
담당자 휴대폰 번호
(Optional)
email?: string
담당자 이메일
(Optional)

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

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

bank: Bank
은행

은행

currency: Currency
통화 단위

통화 단위

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

defaultContractId?: string
파트너에 설정된 기본 계약 아이디
(Optional)

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

tags?: string[]
파트너의 태그 리스트
(Optional)

파트너 업데이트를 위한 유형별 추가 정보
(Optional)

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

Response

200

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

partner: PlatformPartner
파트너

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

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

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

account: PlatformAccount
플랫폼 정산 계좌

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

플랫폼 파트너 상태

플랫폼 파트너 상태

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

파트너 유형별 추가 정보

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

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: 파트너 계좌 검증 아이디를 찾을 수 없는 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAccountVerificationNotFoundError 입니다.
message?: string
(Optional)

409

  • PlatformArchivedPartnerError: 보관된 파트너를 업데이트하려고 하는 경우
  • PlatformAccountVerificationAlreadyUsedError: 파트너 계좌 검증 아이디를 이미 사용한 경우
type: string (Union Tag)
필드의 값이 일 때 타입은 PlatformAccountVerificationAlreadyUsedError 입니다.
message?: string
(Optional)
try
Request
Request Sample
N/A
post/platform/partners/batch

파트너 다건 생성

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

Request

Body

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

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

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

파트너 담당자 정보

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

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

defaultContractId: string
기본 계약 아이디

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

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

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

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

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

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

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

Response

200

성공 응답

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

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

account: PlatformAccount
플랫폼 정산 계좌

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

플랫폼 파트너 상태

플랫폼 파트너 상태

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

파트너 유형별 추가 정보

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

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
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 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

플랫폼 파트너 상태

플랫폼 파트너 상태

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

파트너 유형별 추가 정보

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

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 를 통해 올바른 계좌인지 검증합니다. 그 외의 화폐일 경우 따로 검증하지는 않습니다.

플랫폼 파트너 상태

플랫폼 파트너 상태

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

파트너 유형별 추가 정보

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

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 입니다.

특정 PG사 관련 API

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

타입 정의

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