API & SDK

브랜드페이 자동결제

브랜드페이에서 제공하는 자동결제 SDK 와 API 엔드포인트(Endpoint)의 객체 정보, 파라미터, 요청 및 응답 예제를 살펴보세요.

목차

* 브랜드페이 자동결제는 사용이 제한됩니다. 도입하려면 리스크 검토 및 추가 계약이 필요합니다. 자세한 내용은 토스페이먼츠 고객센터(1544-7772, support@tosspayments.com)로 문의해주세요.

자동결제 인증

브랜드페이 자동결제를 사용하기 위해서는 먼저 사용자에게 자동결제 약관 동의와 비밀번호 인증을 받아야 합니다. 토스페이먼츠 SDK v2에서 제공하는 requestBillingAuth() 메서드를 사용하여 자동결제 인증을 진행할 수 있습니다.

초기화

먼저 토스페이먼츠 SDK v2를 초기화하고 브랜드페이 객체를 생성합니다. v1 sdk는 지원하지 않습니다.

requestBillingAuth()

자동결제 인증창을 띄워 사용자에게 자동결제 약관 동의와 비밀번호 인증을 받습니다.

응답

Promise<void>를 반환합니다. 자동결제 인증이 성공하면 Promise가 resolve되고, 실패하면 reject됩니다.

API

사용자 인증, 결제수단, 결제 등 API 는 브랜드페이 API에서 자세히 설명합니다.

자동결제 실행

POST /v1/brandpay/payments

등록된 결제수단 중 methodKey에 해당하는 결제수단으로 상점에서 원하는 시점에 자동결제를 실행합니다. Basic 인증 방식을 사용합니다.

Request Body 파라미터

  • customerKey 필수 · string

    구매자 ID입니다. 빌링키와 연결됩니다. 다른 사용자가 이 값을 알게 되면 악의적으로 사용될 수 있습니다. 자동 증가하는 숫자 또는 이메일・전화번호・사용자 아이디와 같이 유추가 가능한 값은 안전하지 않습니다. 와 같이 충분히 무작위적인 고유 값으로 생성해주세요. 영문 대소문자, 숫자, 특수문자 -, _, =, ., @ 를 최소 1개 이상 포함한 최소 2자 이상 최대 50자 이하의 문자열이어야 합니다.

    * customerKey클라이언트 키와 다릅니다. 클라이언트 키는 연동을 위한 기본 키로 브라우저에서 SDK를 연동할 때 '클라이언트'를 식별하며, 토스페이먼츠에서 제공합니다.

  • methodKey 필수 · string

    결제수단을 특정하는 키입니다.

    브랜드페이 구매자가 탈퇴하면 methodKey도 더 이상 사용할 수 없습니다. CUSTOMER_STATUS_CHANGED 웹훅으로 탈퇴한 구매자를 확인하세요.

  • amount 필수 · integer

    결제할 금액입니다.

  • orderId 필수 · string

    주문번호입니다. 주문을 구분하는 ID입니다. 충분히 무작위한 값을 생성해서 각 주문마다 고유한 값을 넣어주세요. 영문 대소문자, 숫자, 특수문자 -, _, =로 이루어진 6자 이상 64자 이하의 문자열이어야 합니다.

  • orderName 필수 · string

    구매상품입니다. 예를 들면 생수 외 1건 같은 형식입니다. 최소 1글자 이상 100글자 이하여야 합니다.

  • cardInstallmentPlan integer

    신용 카드의 할부 개월 수입니다. 값을 넣으면 해당 할부 개월 수로 결제가 진행됩니다. 2부터 12사이의 값을 사용할 수 있고, 0이 들어가면 할부가 아닌 일시불로 결제됩니다. 결제 금액이 5만원 이상일 때만 할부가 적용됩니다.

  • cultureExpense 필수 · boolean

    문화비(도서, 공연 티켓, 박물관·미술관 입장권 등) 지출 여부입니다. 결제수단이 계좌일 때만 설정하세요.

    * 카드 결제는 항상 false로 돌아옵니다. 카드 결제 문화비는 카드사에 문화비 소득공제 전용 가맹점번호를 설정하면 자동으로 처리됩니다.

  • customerEmail object

    구매자의 이메일 주소입니다. 결제 상태가 바뀌면 이메일 주소로 결제내역이 전송됩니다.

  • discountCode string

    즉시 할인 코드(카드사 고유 번호)로 결제할 때 함께 넘겨야 하는 값입니다.

  • taxFreeAmount 필수 · integer

    전체 결제 금액 중 면세 금액입니다. 값이 0으로 돌아왔다면 전체 결제 금액이 과세 대상입니다.

    * 일반 상점일 때는 모든 결제 금액이 과세에 해당하기 때문에 0이 돌아옵니다. 면세 상점, 복합 과세 상점일 때만 면세 금액이 돌아옵니다. 더 자세한 내용은 세금 처리하기에서 살펴보세요.

  • useCardPoint boolean

    카드로 결제할 때 설정하는 카드사 포인트 사용 여부입니다. 값을 주지 않거나 값이 false라면 사용자가 카드사 포인트 사용 여부를 결정할 수 있습니다. 이 값을 true로 주면 카드사 포인트 사용이 체크된 상태로 결제창이 열립니다.

    * 추가 계약 후 사용할 수 있습니다. 토스페이먼츠 고객센터(1544-7772, support@tosspayments.com)로 문의해주세요.

Response

성공

자동결제 실행에 성공했다면 Payment 객체가 돌아옵니다.

실패

자동결제 실행에 실패했다면 HTTP 상태 코드와 함께 에러 객체가 돌아옵니다.

자동결제 실행 API에서 발생할 수 있는 에러를 살펴보세요.