Forge Docs
PaymentWallet

Wallet

支払い方法の管理を担当する Sub-Feature

概要

Payment.Wallet は Stripe の支払い方法(PaymentMethod)の追加・削除・一覧取得・デフォルト設定を担当する。

API

Handler

関数説明
attachPaymentMethod(input)支払い方法を追加
detachPaymentMethod(input)支払い方法を削除
listPaymentMethods(input)支払い方法一覧を取得
setDefaultPaymentMethod(input)デフォルトの支払い方法を設定

Service

関数説明
attachPaymentMethod(input)追加処理
detachPaymentMethod(input)削除処理
listPaymentMethods(input)一覧取得処理
setDefaultPaymentMethod(input)デフォルト設定処理

Schema

スキーマ説明
PaymentMethodSchemaPaymentMethod支払い方法
AttachPaymentMethodInputSchemaAttachPaymentMethodInput追加入力
DetachPaymentMethodInputSchemaDetachPaymentMethodInput削除入力
ListPaymentMethodsInputSchemaListPaymentMethodsInput一覧入力
SetDefaultPaymentMethodInputSchemaSetDefaultPaymentMethodInputデフォルト設定入力

使用例

import { Payment } from "@unitto/features";

// 支払い方法一覧
const methods = await Payment.Wallet.Handler.listPaymentMethods({
  customerId: "cus_xxx",
});

// デフォルト設定
await Payment.Wallet.Handler.setDefaultPaymentMethod({
  customerId: "cus_xxx",
  paymentMethodId: "pm_xxx",
});

On this page