빌링키 생성 요청
토스 자동결제를 등록하기 위해서는 사용자를 식별할 수 있는 고유한 빌링키를 생성해야 합니다. API 요청의 응답으로 성공 여부와 함께 토스 앱 인증 URL을 전달합니다.
각 API 응답 필드와 에러코드는 사전 공지 없이 추가되거나 변경될 수도 있으니, 추가된 항목으로 인해 오류가 발생하지 않도록 처리에 유의해 주시기 바랍니다.
https://pay.toss.im/api/v1/billing-key요청 파라미터
apiKeystring필수결제 가맹점의 API Key. 결제 보안상 유의가 필요하며 웹 브라우저에 노출되지 않도록 가맹점의 관리가 필요합니다.
userIdstring필수가맹점 사용자 식별 값. 가맹점에 저장된 회원 아이디를 활용할 수 있습니다. 추후 결제 승인 정보와 매칭하기 위하여 필요하며 유니크한 값을 사용하길 권장합니다. 숫자, 영문자도 가능하되 특수문자는 _ - : . ^ @ = 만 허용합니다.
displayIdstring다중 빌링키 식별 값. 동일한 결제수단을 여러 번 등록하고 싶다면, displayId를 사용하여 여러 개의 빌링키를 생성할 수 있습니다.
productDescstring필수자동결제 상품명. 토스 결제창에 표기될 가맹점의 자동결제 상품명
resultCallbackstring필수가맹점 설정 콜백 URL. 사용자가 토스 앱을 통해 인증을 완료한 후, 이 URL에 인증 결과 데이터를 전달합니다. 콜백 서버는 보안상의 이유로 HTTPS를 권장하며, 80, 443 이외의 포트 사용은 불가합니다.
retAppSchemestring인증완료 후 연결할 가맹점의 앱 스킴. App to App 결제 환경에서는 토스페이 완료 후 가맹점 앱으로 리디렉션하기 위해 앱 스킴 설정이 필요합니다. 특히 iOS 환경에서는 자동 앱 전환이 되지 않아 필수 구현을 권장합니다.
encryptedUserCistring가맹점 유저의 CI값. 가맹점에서 자동결제를 등록하는 사용자의 실명확인을 통해 생성된 사용자 정보를 전달할 수 있습니다.
returnSuccessUrlstring인증성공 후 연결할 가맹점 성공 페이지. retAppScheme이 선언되지 않으면 필수로 보내주셔야 합니다.
returnFailureUrlstring인증실패 시 연결할 가맹점 실패 페이지
응답 파라미터
codeinteger (int32)응답코드. 0: 성공, -1: 실패 (실패 사유는 msg와 errorCode로 제공)
errorCodestring에러 코드
msgstring응답이 성공이 아닌 경우 설명 메시지
billingKeystring생성된 자동결제 사용자 빌링키. 빌링키는 토스 사용자의 고유한 값으로, 한 상점에서 한 개의 빌링키만 허용합니다.
checkoutAndroidUristringAndroid 구독 인증 URI. 생성된 자동결제를 인증할 앱 URL. 가맹점은 구매자의 디바이스 OS를 구분해서 해당 URL로 보내주면 됩니다.
checkoutIosUristringiOS 구독 인증 URI. iOS에서 사용되는 구독 인증 URI로, 토스앱이 설치된 사용자가 앱을 통해 인증을 완료할 수 있도록 합니다.
checkoutUristring토스 앱 호출 링크. retAppScheme가 포함된 경우 onelink를 제공하고, 포함되지 않은 경우 Web 결제용 payfront 링크를 제공합니다.