자동결제(빌링) API로 연동하기
✅ 토스페이먼츠 API만으로 자동결제를 연동하고 구독 결제 서비스를 만들어보세요. (서버 투 서버)
✅ 고객의 카드를 처음 한 번 등록할 때 본인인증을 마치고 빌링키를 발급하면, 별도의 고객 인증 없이 간편하게 빌링키로 계속 결제할 수 있습니다.
✅ API로 자동결제를 연동하면 본인인증은 직접 구현해야 합니다. 결제창 방식으로 연동하면 토스페이먼츠에서 휴대폰 본인인증을 제공합니다.
API 키 준비하기
자동결제는 API 개별 연동 키로 연동하세요.
토스페이먼츠에 회원가입하기 전이라면, 다음 문서 테스트 키로 연동할 수 있어요. 토스페이먼츠에 회원가입했다면, 로그인 후 다음 내 테스트 키로 결제를 연동하고 개발자센터에서 테스트 결제내역을 확인하세요.
// API 개별 테스트 연동 키
// 토스페이먼츠에 회원 가입하기 전이라면 아래 키는 문서 테스트 키입니다.
// 토스페이먼츠에 회원 가입하고 로그인한 상태라면 아래 키는 내 테스트 키입니다.
const clientKey = 'test_ck_D5GePWvyJnrK0W0k6q8gLzN97Eoq'
const secretKey = 'test_sk_zXLkKEypNArWmo50nX3lmeaxYG5R'
자동결제는 추가 계약 후 테스트 및 라이브 환경에서 사용할 수 있습니다. 추가 계약을 하고 싶다면 토스페이먼츠 고객센터(1544-7772, support@tosspayments.com)로 문의해주세요.
자동결제 연동 흐름 이해하기
큰 흐름은 다음과 같습니다.
- 빌링키 발급 API 요청 (Server): API로 빌링키를 발급하고 데이터베이스에 저장하세요. 빌링키 발급 전 본인인증은 직접 구현해야 합니다.
- 빌링 결제 승인 요청 (Server): API로 발급한 빌링키로 원하는 주기, 시점에 자동결제를 실행하세요. 스케줄링 기능은 직접 구현해야 합니다. 스케줄링 예제를 참고하세요.
API로 연동하면 UI는 직접 구현해야 합니다. 결제창 방식으로 연동하면 토스페이먼츠에서 카드 등록창과 본인인증 기능을 제공합니다.
1. 빌링키 발급하기
카드 번호, 카드 유효기간, 카드 소유자의 생년월일, 카드 비밀번호 등을 빌링키 발급 요청 API 본문에 포함하세요. 카드 번호와 카드 유효기간은 필수 파라미터입니다. 카드 정보는 빌링키를 발급할 때만 한 번 사용되고, 이후에는 카드 정보 대신 발급한 빌링키로 결제를 실행합니다. 토스페이먼츠와 계약할 때 요청하면 비밀번호, 카드 소유자의 생년월일 정보도 빌링키 발급을 위한 필수 파라미터로 추가할 수 있습니다.
customerKey도 요청 본문에 포함해야 합니다. customerKey는 가맹점에서 고객을 특정하는 값으로, 빌링키가 발급되면 이 값에 매핑됩니다.
먼저 API 인증을 위해 아래와 같이 인증 헤더 값을 만듭니다.
시크릿 키 뒤에 :을 추가하고 base64로 인코딩합니다. :을 빠트리지 않도록 주의하세요.
base64('test_sk_zXLkKEypNArWmo50nX3lmeaxYG5R:')
─────────────────┬───────────────── ┬
secretKey :
발급받은 시크릿 키 콜론
아래 명령어를 터미널에서 실행하면 인코딩된 값을 얻을 수 있습니다.
echo -n 'test_sk_zXLkKEypNArWmo50nX3lmeaxYG5R:' | base64
인코딩된 값을 Basic 인증 헤더에 넣고 요청 본문도 추가하세요. 앞 단계에서 리다이렉트 URL로 받은카드 자동결제 빌링키 발급 요청 API를 호출합니다. authKey, customerKey 값을 요청 본문으로 보냅니다.
자동결제 계약이 안 되어 있는 클라이언트 키로 연동하면 발생합니다. 자동결제 계약이 되어있는 클라이언트 키를 사용하거나 토스페이먼츠 고객센터(1544-7772, support@tosspayments.com)로 문의해주세요.
테스트 환경에서는 카드 번호의 앞 여섯 자리(BIN 번호)만 유효해도 자동결제가 등록됩니다. 라이브 환경에서는 전체 카드 번호가 유효해야 등록됩니다.
API 호출 결과로 HTTP 200 OK를 받으면 빌링키 발급 성공입니다. 이제 응답 본문에 포함된 billingKey를 이용해 결제 승인을 요청합니다.
{
"mId": "tosspayments",
"customerKey": "",
"authenticatedAt": "2021-01-01T10:01:30+09:00",
"method": "카드",
"billingKey": "",
"card": {
"issuerCode": "61",
"acquirerCode": "31",
"number": "43301234****123*",
"cardType": "신용",
"ownerType": "개인"
}
}
빌링키 관리하기
빌링키를 고객을 특정하는 customerKey와 매핑해서 서버에 저장하세요. 한 번 발급된 빌링키는 다시 조회할 수 없습니다. 저장한 키 값으로 자동결제를 요청해주세요.
빌링키의 유효기간은 빌링키와 연결된 카드 유효기간과 같습니다. 발급된 빌링키를 삭제하는 기능은 제공하지 않습니다. 발급된 빌링키가 더 이상 필요하지 않으면 데이터베이스에서 삭제하고 더 이상 사용하지 않으면 됩니다. 혹시 누군가가 빌링키 정보를 알고 있더라도 빌링키와 매핑된 customerKey를 모른다면 결제가 불가능합니다. 빌링키를 사용한 결제는 빌링키를 발급할 때 같이 전달된 customerKey와 매핑이 되어있기 때문에, 결제 요청을 할 때 빌링키와 customerKey가 같이 전달되어야 결제가 진행됩니다.
새로운 카드 정보로 빌링키를 다시 발급하세요. 별도로 빌링키를 갱신하는 과정은 없습니다.
2. 빌링키로 자동결제 실행하기
발급한 billingKey를 카드 자동결제 승인 API의 Path 파라미터로 추가합니다. 요청 본문에는 주문 정보와 함께 customerKey를 포함합니다.
customerkey와 매핑되지 않은 billingKey를 사용하면 발생합니다.
구독 스케줄링 예제
토스페이먼츠에서는 자체적으로 스케줄링 기능을 제공하지 않습니다. 따라서 가맹점에서 직접 스케줄링 기능을 구현해서 원하는 주기, 시점에 결제를 실행해야 합니다.
만약 Node.js 애플리케이션에 스케줄링 로직을 추가하려면, node-cron과 같은 패키지를 사용할 수 있습니다. 이 패키지를 사용하면 스케쥴을 정의하고 그에 따라 특정 작업을 자동으로 실행할 수 있습니다. 각 언어나 프레임워크에서 제공하는 스케줄링 기능을 사용하세요.
먼저 node-cron 패키지를 설치해야 합니다. 프로젝트의 루트 디렉토리에서 다음 명령어를 실행하세요.
npm install --save node-cron
이제 node-cron을 사용하여 매월 1일에 자동결제를 진행하는 스케쥴러를 설정할 수 있습니다. 아래 코드는 기존 routes/index.js 파일에 스케쥴러를 추가하는 방법을 보여줍니다:
var express = require("express");
var got = require("got");
var cron = require("node-cron"); // 스케줄링을 위해 cron 잡을 수행할 수 있는 node-cron 패키지 추가
var uuid = require("uuid").v4;
var router = express.Router();
router.get("/", function (req, res) {
res.render("index");
});
router.get("/billing_confirm", function (req, res) {
// ...
}
// 매 달 1일 01:00에 스케줄링을 수행하는 cron 잡 추가
cron.schedule("0 0 1 * *", function() {
console.log("매월 1일 01:00에 결제 실행하기");
got.post("https://api.tosspayments.com/v1/billing/" + billingKey, {
headers: {
Authorization:
"Basic " + Buffer.from(secretKey + ":").toString("base64"),
"Content-Type": "application/json",
},
json: {
customerKey: "test_customer_key",
amount: 50000,
orderId: uuid(),
orderName: ‘토스 프라임 구독’,
customerEmail: "customer@email.com",
customerName: "박토스",
taxFreeAmount: 0
},
responseType: "json",
})
.then(function (response) {
console.log(response.body);
})
.catch(function (error) {
console.log(‘Error:’, error);
});
})
// ...
위 코드는 매월 1일에 billingKey`를 사용하여 자동결제를 진행하는 스케쥴러입니다. 이러한 방식으로 스케줄링 로직을 추가하면, 매월 1일마다 자동으로 지정된 결제가 진행됩니다. 실제 서비스에서는 에러 처리, 로깅, 데이터베이스와의 통신 등이 추가로 필요할 수 있습니다.
다음 결제일에 구독을 취소한 고객의 빌링키, 고객키로 카드 자동결제 승인 API를 호출하지 않으면 됩니다.
카드 자동결제 승인 API를 호출할 때 amount 파라미터를 변경된 결제 금액으로 설정하면 됩니다.
카드 자동결제 승인 API를 호출하는 주기를 변경해주세요.
카드 등록과 첫 번째 자동결제 같이 하기
billingKey가 발급되는 동시에 자동결제 승인 API를 호출하면 카드 자동결제 등록과 결제가 한 번에 완료됩니다.
-
만약 정기적으로 발생하는 결제가 아니라 원하는 시점에 결제를 내고 싶다면 자체 간편결제 서비스인 브랜드페이를 연동하세요.
-
해외카드, 해외결제는 정기결제를 지원하지 않습니다.
3. 결제 완료 후 응답 확인하기
요청이 승인되면 빌링키를 발급할 때 등록했던 카드로 결제되고, card 객체가 포함된 응답이 돌아옵니다.
{
"mId": "tosspayments",
"version": "2022-11-16",
"paymentKey": "",
"status": "DONE",
"transactionKey": "",
"lastTransactionKey": "",
"orderId": "",
"orderName": "토스 프라임 구독",
"requestedAt": "2022-06-08T15:40:09+09:00",
"approvedAt": "2022-06-08T15:40:49+09:00",
"useEscrow": false,
"cultureExpense": false,
"card": {
"issuerCode": "61",
"acquirerCode": "31",
"number": "43301234****123*",
"installmentPlanMonths": 0,
"isInterestFree": false,
"interestPayer": null,
"approveNo": "00000000",
"useCardPoint": false,
"cardType": "신용",
"ownerType": "개인",
"acquireStatus": "READY",
"amount": 4900
},
"virtualAccount": null,
"transfer": null,
"mobilePhone": null,
"giftCertificate": null,
"cashReceipt": null,
"cashReceipts": null,
"discount": null,
"cancels": null,
"secret": null,
"type": "BILLING",
"easyPay": null,
"country": "KR",
"failure": null,
"isPartialCancelable": true,
"receipt": {
"url": "https://merchants.tosspayments.com/web/serve/merchant/test_ck_D5GePWvyJnrK0W0k6q8gLzN97Eoq/receipt/"
},
"checkout": {
"url": "https://api.tosspayments.com/v1/payments//checkout"
},
"currency": "KRW",
"totalAmount": 4900,
"balanceAmount": 4900,
"suppliedAmount": 4455,
"vat": 455,
"taxFreeAmount": 0,
"taxExemptionAmount": 0,
"method": "카드"
}