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

온보딩 API - 별도 계약 필요

온보딩에 관련된 API 를 확인할 수 있습니다.

⌨ 하위상점의 전자결제 신청 정보를 가져오기 (호스팅사 > 포트원)

GET https://api.portone.io/v2/stores/{store-id}/applications

하위상점의 전자결제 신청 정보를 가져오기 (호스팅사 > 포트원)

하위상점 등록 API를 통해서 호스팅사의 사업자 정보를 포트원에 전달하면 전자결제 신청을 위해 하위상점의 전자결제 신청 정보, 계약 진행 상태 정보를 가져옵니다.

Parameters

Authorization*
string

jwt 토큰 헤더

Path

store-id*
string

store의 id

Responses

200
조회 성공

applications * Array[ApplicationPublic]

전자결제 신청내역

ApplicationPublic

id * string

전자결제 신청 id


store_id string

전자결제 신청한 store id


pg_company * PgCompany

PG사

"UNIDENTIFIED", "NICE", "KCP", "KICC", "DANAL", "SETTLE", "INICIS", "SMARTRO", "TOSSPAYMENTS", "DAOU", "KSNET", "MOBILIANS", "EXIMBAY", "PAYPAL", "PAYMENTWALL", "NAVERPAY", "NAVERCO", "KAKAOPAY", "TOSSPAY", "CHAI", "PAYCO", "SMILEPAY"


methods * Array[MethodAndType]

해당 PG사로 신청한 결제수단 및 방식

"CARD_GENERAL", "CARD_SUBSCRIBE", "CARD_KEYIN", "TRANS_GENERAL", "VBANK_GENERAL", "PHONE_GENERAL", "PHONE_SUBSCRIBE", "GIFT_CARD_GENERAL", "ABROAD_GENERAL", "MY_ACCOUNT_GENERAL", "NAVERPAY_GENERAL", "NAVERCO_GENERAL", "KAKAOPAY_GENERAL", "TOSSPAY_GENERAL", "PAYCO_GENERAL", "SMILEPAY_GENERAL", "CERTIFICATION_PHONE", "CERTIFICATION_UNIFIED"


status * ApplicationStatusClass

신청 상태 대분류

"RECEPTION_SCHEDULED", "TRANSFER", "RECEPTION_PENDING", "RECEPTION_COMPLETED", "APPLICATION_CANCELED", "MERCHANT_REVIEWING", "CONTRACT_PROCESSING", "CONTRACT_COMPLETED", "CONTRACT_CANCELED", "CONTRACT_PENDING", "CONTRACT_REJECTED", "SERVICE_CLOSED", "SERVICE_OPEN"


pg_specific_info * PgSpecificInfo

PG사별 특수값


failed_reason string

실패 사유


pg_credential object

결제 연동에 필요한 Credential


created * string

생성 시각


modified * string

수정 시각



400
요청 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



401
토큰 인증 실패

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



404
존재하지 않는 리소스 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



500
서버 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



⌨ 온보딩 API 를 통해 전자결제 신청하기 (호스팅사 > 포트원 > 결제대행사)

POST https://api.portone.io/v2/stores/{store-id}/applications

온보딩 API 를 통해 전자결제 신청하기 (호스팅사 > 포트원 > 결제대행사)

호스팅사 고객의 사업자 정보를 기반으로 생성된 스토어 식별코드로 전자 결제를 신청합니다.

Parameters

Header

Authorization*
string

jwt 토큰 헤더

Path

store-id*
string

store의 id

Body

applications*
Array[ApplicationByPgCompany]

pg사 기준으로 묶은 application

pg_specific_info*
PgSpecificInfo

PG사별 특수값

Responses

200
전자결제 신청 성공

applications * Array[ApplicationPublic]

전자결제 신청내역

ApplicationPublic

id * string

전자결제 신청 id


store_id string

전자결제 신청한 store id


pg_company * PgCompany

PG사

"UNIDENTIFIED", "NICE", "KCP", "KICC", "DANAL", "SETTLE", "INICIS", "SMARTRO", "TOSSPAYMENTS", "DAOU", "KSNET", "MOBILIANS", "EXIMBAY", "PAYPAL", "PAYMENTWALL", "NAVERPAY", "NAVERCO", "KAKAOPAY", "TOSSPAY", "CHAI", "PAYCO", "SMILEPAY"


methods * Array[MethodAndType]

해당 PG사로 신청한 결제수단 및 방식

"CARD_GENERAL", "CARD_SUBSCRIBE", "CARD_KEYIN", "TRANS_GENERAL", "VBANK_GENERAL", "PHONE_GENERAL", "PHONE_SUBSCRIBE", "GIFT_CARD_GENERAL", "ABROAD_GENERAL", "MY_ACCOUNT_GENERAL", "NAVERPAY_GENERAL", "NAVERCO_GENERAL", "KAKAOPAY_GENERAL", "TOSSPAY_GENERAL", "PAYCO_GENERAL", "SMILEPAY_GENERAL", "CERTIFICATION_PHONE", "CERTIFICATION_UNIFIED"


status * ApplicationStatusClass

신청 상태 대분류

"RECEPTION_SCHEDULED", "TRANSFER", "RECEPTION_PENDING", "RECEPTION_COMPLETED", "APPLICATION_CANCELED", "MERCHANT_REVIEWING", "CONTRACT_PROCESSING", "CONTRACT_COMPLETED", "CONTRACT_CANCELED", "CONTRACT_PENDING", "CONTRACT_REJECTED", "SERVICE_CLOSED", "SERVICE_OPEN"


pg_specific_info * PgSpecificInfo

PG사별 특수값


failed_reason string

실패 사유


pg_credential object

결제 연동에 필요한 Credential


created * string

생성 시각


modified * string

수정 시각



400
요청 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



401
토큰 인증 실패

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



403
권한 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



404
존재하지 않는 리소스 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



500
서버 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



pg_company * PublicPgCompany

PG사

"UNIDENTIFIED", "TOSSPAYMENTS"


methods * Array[PublicMethodAndType]

결제 수단 및 방식
CARD_GENERAL: 카드 일반결제
CARD_SUBSCRIBE: 카드 정기결제
TRANS_GENERAL: 계좌이체 일반결제
VBANK_GENERAL: 가상계좌 일반결제
PHONE_GENERAL: 휴대폰 일반결제
GIFT_CARD_GENERAL: 상품권 일반결제\

"CARD_GENERAL", "CARD_SUBSCRIBE", "TRANS_GENERAL", "VBANK_GENERAL", "PHONE_GENERAL", "GIFT_CARD_GENERAL"


PG사

"UNIDENTIFIED", "TOSSPAYMENTS"

⌨ 가입 신청 URL 호출 & 상태값 조회하기

GET https://api.portone.io/v2/stores/{store-id}/applications/tosspayments-status-and-url

가입 신청 URL 호출 & 상태값 조회하기

1. 가입 신청 URL 호출 (호스팅사 > 포트원 > 결제대행사) - 토스페이먼츠 전용

2. 상태값 조회하기 (결제대행사 > 포트원 > 호스팅사)

Parameters

Header

Authorization*
string

jwt 토큰 헤더

Path

store-id*
string

store의 id

Responses

200
조회 성공

urls Array[TosspaymentsApplicationUrl]

TosspaymentsApplicationUrl

application_id * string

전자결제 신청 id


payment_type * string

GENERAL: 일반결제
SUBSCRIBE: 정기결제
EASY: 간편결제\

"GENERAL", "SUBSCRIBE", "EASY"


onboarding_url string

토스페이먼츠 온보딩페이지 url status가 READY, IN_DRAFT인 경우만 값이 담겨짐


status * string

토스페이먼츠 계약 상태 (토스페이먼츠에서 내려주는 상태값)
READY: 신청서 작성 전
IN_DRAFT: 신청서 작성 중
WAIT_FOR_REVIEW: 신청서 제출 완료
IN_REVIEW: 심사 중
DONE: 계약 완료
CANCELED: 계약 취소
TERMINATED: 계약 해지\

"READY", "IN_DRAFT", "WAIT_FOR_REVIEW", "IN_REVIEW", "DONE", "CANCELED", "TERMINATED"



400
요청 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



401
토큰 인증 실패

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



404
존재하지 않는 리소스 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지



500
서버 에러

code * string

에러 코드


params * object

에러 세부사항

params

message string

에러 메시지