온보딩 API - 별도 계약 필요
포트원의 온보딩 API는 고객이 호스팅사를 통해서 직접 전자결제를 신청할 수 있도록 포트원의 하위 상점 등록, 전자결제신청 URL 조회(토스페이먼츠 전용), 계약 정보 조회 기능을 제공합니다.
- 1.하위상점 등록 API포트원 파트너십 팀과의 별도 계약을 통해서 호스팅사가 포트원의 가맹점(Merchant)으로 등록되면, 하위상점 등록 API 호출을 통해서 호스팅사의 고객은 포트원의 상점(Store)이 됩니다. 포트원은 각 상점마다 식별 코드를 부여합니다. 상세 내용은 가맹점 관리 API 명세 내용을 참조해 주세요.
- 2.온보딩 API 고객은 포트원이 부여한 식별코드를 기반으로 전자결제 신청을 할 수 있습니다. 결제수단은 결제대행사에 따라 상이하며, 토스페이먼츠의 경우, 일반/정기/허브형 결제를 지원합니다.
- 3.가입 신청 URL 호출 API (토스페이먼츠 전용) 토스페이먼츠의 경우 추가 정보 입력을 요구하기 때문에, 가입 신청 URL을 호출을 통해 고객이 추가 정보를 입력할 수 있도록 지원합니다.
- 4.계약 조회 API 전자결제 계약을 조회할 수 있는 API입니다. 계약 조회 API를 호출하여 PG사 계약 상태 및 카드사 심사 상태를 조회할 수 있습니다.
호스팅사에서 하위상점 등록 API를 통해서 호스팅사의 사업자 정보를 포트원에 전달하면 전자결제 신청을 위해 하위상점의 사업자 정보, 전자결제 신청 정보, 계약 정보를 가져옵니다.
get
https://api.portone.io/v2
/stores/{store-id}/applications
하위상점의 모든 application 가져오기
호스팅사 고객의 사업자 정보를 기반으로 생성된식별코드 (store-id)로 전자 결제를 신청합니다.
post
https://api.portone.io/v2
/stores/{store-id}/applications
전자결제 신청하기
ApplicationByPgCompany
BankName
PgSpecificInfo
PublicMethodAndType
pg_company * PublicPgCompanyPG사
"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"
은행
"BANK_OF_KOREA", "KDB", "IBK", "KB", "HANA", "SH", "KOREA_EXIMBANK", "NH", "WOORI", "SHINHAN", "SC", "CITY", "DGB", "BOOSAN_BANK", "KJ_BANK", "JEJU_BANK", "JB_BANK", "KN_BANK", "MG", "CU", "SB", "BOA", "MORGAN_STANLEY", "HSBC", "DEUTSCHE_BANK", "JP_MORGAN", "BNP_PARISBAS", "ICBC", "BANK_OF_CHINA", "SJ", "CHINA_CONSTRUCTION_BANK", "POST_BANK", "K_BANK", "KAKAO_BANK", "TOSS_BANK"delivery_or_service_period string배송 및 서비스 기간
development_method string개발 방식
"SELF_DEVELOPMENT", "WORDPRESS"
supporting_countries Array[string]결제 제공 국가 (ISO 3166-1 alpha-2)
payco_id string페이코 ID
bank_name BankName은행
"BANK_OF_KOREA", "KDB", "IBK", "KB", "HANA", "SH", "KOREA_EXIMBANK", "NH", "WOORI", "SHINHAN", "SC", "CITY", "DGB", "BOOSAN_BANK", "KJ_BANK", "JEJU_BANK", "JB_BANK", "KN_BANK", "MG", "CU", "SB", "BOA", "MORGAN_STANLEY", "HSBC", "DEUTSCHE_BANK", "JP_MORGAN", "BNP_PARISBAS", "ICBC", "BANK_OF_CHINA", "SJ", "CHINA_CONSTRUCTION_BANK", "POST_BANK", "K_BANK", "KAKAO_BANK", "TOSS_BANK"
account_number string계좌번호
account_holder_name string예금주명
homepage_name string홈페이지 명 (서비스 명)
nicepay_terms_agreed Array[boolean]약관들 동의 여부
결제 수단 및 방식
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"PublicPgCompany
PG사
"UNIDENTIFIED", "TOSSPAYMENTS"- 1.가입 신청 URL 호출 API로 추가 정보 입력 - 토스페이먼츠 한정 (호스팅사 > 포트원 > 결제대행사) Store별로 토스페이먼츠에 가입 신청 URL을 요청합니다. 가입 신청 URL은 가입 단계가 끝난 경우 (계약 완료 또는 계약 취소가 진행된 경우) 조회할 수 없습니다.
- 2.상태값 조회 API로 계약 상황 조회하기 (결제대행사 > 포트원 > 호스팅사) 전자결제 계약 상태를 조회할 수 있는 API입니다. 상태값 조회 API를 호출하여 PG 계약 상태 및 카드사 심사 상태를 조회할 수 있습니다.
get
https://api.portone.io/v2
/stores/{store-id}/applications/tosspayments-status-and-url
상점(Store)별 가입 신청 URL 호출 API & 상태값 조회 API 활용
Last modified 7d ago