Stripe Checkoutを利用すると、カード決済以外の決済方法も簡単にサポートすることができます。
今回は、その中でも2022年春に登場した「銀行振込」をサポートする方法を紹介します。
Checkoutで銀行振込をサポートするために必要な３つの値
Checkoutで銀行振込をサポートするには、以下の値を設定する必要があります。
-
customer: Stripe上の顧客ID -
payment_method_types: 利用する支払い方法の設定 -
payment_method_options: どの国の銀行振込を利用するかなどのオプション設定
Step1: 口座情報を紐づけるための顧客データを作成する
Stripeで銀行振込による決済を処理するには、顧客データと口座情報を紐づける必要があります。
そのため、Stripe CheckoutでCheckoutセッションを作成するAPIを呼び出す際、customerで顧客のIDを指定しましょう。
+ const customer = await stripe.customers.create()
const session = await stripe.checkout.sessions.create({
+ customer: customer.id,
line_items: [{
price: 'price_xxxx',
quantity: 1
}],
mode:'payment',
success_url: 'https://example.com',
cancel_url: 'https://example.com',
})
customerの設定が漏れている場合、APIがThe payment method 'customer_balance' requires customer to be set.エラーを返します。
Step2: payment_method_typesで銀行振込を指定する
続いて、Checkoutでサポートする決済方法を指定します。
ダッシュボード側で決済方法を指定する方法もありますので、こちらもご確認ください。
銀行振込の場合、payment_method_typesにcustomer_balanceを指定します。
クレジットカード・コンビニ決済・銀行振込をサポートする場合は、次の通りです。
const customer = await stripe.customers.create()
const session = await stripe.checkout.sessions.create({
customer: customer.id,
line_items: [{
price: 'price_xxxx',
quantity: 1
}],
mode:'payment',
+ payment_method_types: [
+ 'card',
+ 'konbini',
+ 'customer_balance'
+ ],
success_url: 'https://example.com',
cancel_url: 'https://example.com',
})
Step3: payment_method_optionsで銀行振込の設定を行う
最後に、payment_method_optionsで、「どの国の銀行振込を利用するか」を指定します。
const customer = await stripe.customers.create()
const session = await stripe.checkout.sessions.create({
customer: customer.id,
line_items: [{
price: 'price_xxxx',
quantity: 1
}],
mode:'payment',
payment_method_types: [
'card',
'konbini',
'customer_balance'
],
+ payment_method_options: {
+ customer_balance: {
+ funding_type: 'bank_transfer',
+ bank_transfer: {
+ type: 'jp_bank_transfer',
+ },
+ },
+ },
success_url: 'https://example.com',
cancel_url: 'https://example.com',
})
表示内容を確認する
最後に、サンプルのコードを実行して、stripe.checkout.sessions.createの戻り値を取得しましょう。
URLにアクセスすると、銀行振込を決済方法として選択できる決済ページが表示されます。
$ node example.js
{
...
url: 'https://checkout.stripe.com/pay/cs_test_xxxx'
}
[支払う]ボタンをクリックすると、コンビニ決済と同じく入金のための情報が表示されます。
Checkoutで銀行振込をサポートする際の注意点
Checkoutでの決済完了後、リダイレクトされない
コンビニ決済や銀行振込など、振込・入金等の操作が必要な決済方法では、セッション完了後に支払い方法の案内ページに移動します。
そのため、success_urlで指定したページへのリダイレクトが行われません。
Google Analyticsのコンバージョントラッキングや、注文後に表示したい項目があるアプリ・サービスなどでは、実装にご注意ください。
Subscriptionの場合は、mode: 'subscription'に変更する
銀行振込に限らず、Checkoutを利用する際にミスしがちな点です。
「1回限りの決済」と「サブスクリプション」、そして「決済情報の登録のみ」では、modeの値が変わります。
１つでもサブスクリプション商品が混ざっている場合は、modeをsubscriptionに設定しましょう。
WebhookやZapierで、入金完了後に発送等の処理を行う
銀行振込の場合、Checkoutのセッション完了時点ではまだ顧客からの入金はありません。
そのため、すでにカード決済などで注文完了後に別のシステムと連携させている場合は、連携タイミングの調整が必要です。
checkout.session.completedを利用している場合
すでにcheckout.session.completedのWebhookイベントを利用している場合は、「決済ステータスの確認」処理を追加しましょう。
if (event.type === 'checkout.session.completed') {
const session = event.data.object;
+ if (session.payment_status === 'paid') {
// 発送業務等のシステム連携処理
+ }
}
これにより、銀行振込やコンビニ決済・３Dセキュアによる追加認証などで、決済が未完了状態の注文を発送等の処理にまわすことを防止できます。
checkout.session.async_payment_succeededで銀行振込の入金完了イベントを受け取る
Checkoutのみを利用している場合、checkout.session.async_payment_succeededイベントを利用して、コンビニ決済や銀行振込の注文を処理します。
if (event.type === 'checkout.session.async_payment_succeeded') {
const session = event.data.object;
// 発送業務等のシステム連携処理
}
複数の決済方法をCheckoutでサポートする場合
checkout.session.async_payment_succeededイベントは、クレジットカードなどのその場で決済が完了する決済方法では利用されません。
そのため、複数の決済方法をサポートする場合は、checkout.session.completedとcheckout.session.async_payment_succeeded両方を利用しましょう。
if (event.type === 'checkout.session.completed') {
const session = event.data.object;
if (session.payment_status === 'paid') {
// クレジットカードなどの即時決済での、発送業務等のシステム連携処理
}
} else if (event.type === 'checkout.session.async_payment_succeeded') {
const session = event.data.object;
// 銀行振込などの非同期型決済での、発送業務等のシステム連携処理
}
Payment Links / Pricing Tableでは利用できない (2022/09/02時点)
現時点では、Payment Links（支払いリンク）やPricing Table(料金表)を利用した場合、銀行振込での決済ができません。
これは、２つの製品が2022/09/02時点で、customer_idの指定をサポートしていないためです。
今後のアップデートで、IDが指定できるようになれば、利用できる可能性がありますので、変更があれば随時更新いたします。
Checkoutで、銀行振込でのサブスクリプションは開始できない (2022/09/02時点)
現時点では、Checkoutで開始したサブスクリプションは自動的に決済処理されます。（collection_method="charge_automatically"）
銀行振込はcollection_method="send_invoice"でサブスクリプションを開始する必要があるため、サブスクリプションの支払い方法に指定すると以下のエラーが発生します。
The payment method `customer_balance` cannot be used in `subscription` mode.
銀行振込をサポートするサブスクリプションの作成方法は、以下の記事を参考にしてください。
[PR] Stripe開発者向け情報をQiitaにて配信中！
- [Stripe Updates]：開発者向けStripeアップデート紹介・解説
- ユースケース別のStripe製品や実装サンプルの紹介
- Stripeと外部サービス・OSSとの連携方法やTipsの紹介
- 初心者向けのチュートリアル(予定)
など、Stripeを利用してオンラインビジネスを始める方法について週に２〜３本ペースで更新中です。