Stripeの銀行振込では、顧客ごとに振込先の口座情報が発行されます。
この情報は、請求書やサブスクリプションでは顧客にメールで送付され、1回きりの注文 (Payment Intents)では、レスポンスの.next_actions
から取得できます。
今回の記事では、SaaSやメンバーシップサービス・予約販売などで、「任意のタイミングで、口座情報を取得・表示する方法」を紹介します。
方法1: Dashboardから直接確認する
顧客サポートなど、コードやコマンドを実行せずに口座情報を調べたいケースでは、Stripe Dashboardを利用します。
該当の顧客詳細ページを開き、[支払い方法]の[現金残高]をクリックしましょう。
入金済みの残高と通貨情報が表示されます。
ここで[残高の詳細を表示]リンクをクリックすると、その顧客が振り込みに利用する口座情報が表示されます。
入金・返金の履歴や、どの支払いに割り当てられたかの履歴も確認できます。
方法2: 顧客データ作成時など、任意のタイミングで取得する
もうひとつの方法は、APIを呼び出して明示的に取得する方法です。
以下のように、資金供給のためのAPIを呼び出しましょう。
const result = await stripe.customers.createFundingInstructions('cus_xxxx', {
currency: 'jpy',
funding_type: 'bank_transfer',
bank_transfer: {
type: 'jp_bank_transfer'
}
})
result
には、その顧客に割り当てられた銀行口座情報が含まれます。
{
"object": "funding_instructions",
"bank_transfer": {
"country": "JP",
"financial_addresses": [
{
"supported_networks": [
"zengin"
],
"type": "zengin",
"zengin": {
"account_holder_name": "ストライプジャパン(カ シュウノウダイコウ",
"account_number": "1234567",
"account_type": "futsu",
"bank_code": "1234",
"bank_name": "いろは銀行",
"branch_code": "001",
"branch_name": "中央支店"
}
}
],
"type": "jp_bank_transfer"
},
"currency": "jpy",
"funding_type": "bank_transfer",
"livemode": false
}
createFundingInstructions
を複数回実行しても、customer_id
が同一であれば、口座番号などは同じものが取得できます。
「入金済み・未決済」の残高を取得する
SaaSなどのサブスクリプションや予約販売などでは、顧客が入金してから決済されるまでに少し時間が空くことがあります。
その場合、「すでに十分な額が入金できているか」をUIで表示することで、顧客が不安になってサポートに問い合わせするなどのケースを減らせます。
StripeではCustomer APIを利用して、銀行振込で入金済みの金額を取得できます。
const { cash_balance: cashBalance } = await stripe.customers.retrieve('cus_xxxx', {
expand: ['cash_balance']
})
入金済みの金額がある場合、以下のように金額や消し込みモードの設定などが取得できます。
{
"object": "cash_balance",
"available": {
"jpy": 2500
},
"customer": "cus_xxxx",
"livemode": false,
"settings": {
"reconciliation_mode": "automatic"
}
}
[PR] Stripe開発者向け情報をQiitaにて配信中!
- [Stripe Updates]:開発者向けStripeアップデート紹介・解説
- ユースケース別のStripe製品や実装サンプルの紹介
- Stripeと外部サービス・OSSとの連携方法やTipsの紹介
- 初心者向けのチュートリアル(予定)
など、Stripeを利用してオンラインビジネスを始める方法について週に2〜3本ペースで更新中です。