債務額、取引、および調整非公開プレビュー
FundingObligation の詳細を確認して調整を行います。
FundingObligation を取得する
時間が経過すると、連結アカウントには、複数の返済済み (または past_) の FundingObligation インスタンスが生じ、保留中の FundingObligation は多くても 1 つとなります。現在の期間の FundingObligation を取得するには、次のコマンドを実行します。
資金追加の義務に関するレスポンスの例
[ { "id": "ifo_123", "livemode": true, "created": 1654628149, "amount_total": 10000, "amount_outstanding": 10000, "amount_paid": 0, "currency": "usd", "status": "unpaid", "due_at": 1654714851, "owed_to": "acct_123", "credit_period_starts_at": 1654625149, "credit_period_ends_at":1654713851, "paid_at": nil, "finalized_at": 1654713860, }, ]
特定のステータスの FundingObligations を取得するには、FundingObligations のリストをリクエストする際に特定のステータス値を渡します。次の API コールでは、status が past_ の FundingObligations を取得します。
アカウントの債務に対する元帳の調整
Credit Ledger API を使用して、通常のビジネスプロセスで発生するカード外取引アクティビティーに関するインサイトを記録して維持できます。Credit Ledger API を使用すると、以下のことが可能になります。
- 利用可能なクレジットと資金追加の義務を調整するためのカード外取引アクティビティーのアカウント
- アカウントの利用可能なクレジット金額を取得する
- 調整とカード支出アクティビティーの両方を 1 つの明細書にまとめる
| クレジット調整 | デビット調整 |
|---|---|
クレジット調整では、連結アカウントがお客様に支払うべき金額が「減少」し、連結アカウントの利用可能なクレジットが「増加」します。例を以下に示します。
| デビット調整では、連結アカウントがお客様に支払うべき金額が「増加」し、連結アカウントの利用可能なクレジットが「減少」します。例を以下に示します。
|
連結アカウントの貸方元帳に調整を適用するプロセスを示すために、Barbell (Gymbox の連結アカウントの 1 つ) に 1,000 USD のクレジット限度額が設定されており、シフトマネージャーの 1 人が Barbell 支払いカードを使用して昼食に 2 本のプロテインバーを購入して 10 USD を支払った場合を考えます。ただし、Barbell の支出に関するポリシーでは、このような個人的な支出は禁止されているため、カード保有者は、給与控除を通じて Barbell に返済する必要があります。
以下の表は、Credit Ledger API を使用した Stripe でのイベントシーケンスの概要を示しています。この表に示されている金額と値の変更はすべて、振替のみです。このプロセスでは実際の資金は移動されません。
| アクション | Barbell の Issuing 残高 (連結アカウント) | Gymbox に対する Barbell の FundingObligation | Barbell の利用可能なクレジット | Gymbox の Issuing 残高 (プラットフォーム) |
|---|---|---|---|---|
| Barbell は残高が 0 USD で、以前の支出が 100 USD の状態から開始します。Gymbox は、以前にキャプチャーした取引で 100 USD 減額された 10,000 USD の残高から開始します。 | 0 USD | 100 USD | 900 USD | 9,900 USD |
| カード保有者がさらに 10 USD の取引を行い、Gymbox にはこの取引に対応できる十分な Issuing 残高があるため、この取引はオーソリされます。オーソリの保留の結果、Gymbox の Issuing 残高は 10 USD 減ります。 | -10 USD | 100 USD | 900 USD | 9,890 USD |
| オーソリ決済時 (通常は翌日)、Stripe は 1. オーソリ決済を行い、2. Gymbox の残高を 10 USD 減らし、Barbell の残高を 10 USD 増やし、3. Barbell の FundingObligation を 10 USD 増やします。 | 0 USD | 110 USD | 890 USD | 9,890 USD |
| Barbell はシフトマネージャーから支払いを受け取り、10 USD を Gymbox に送り返します。Gymbox は、対応する 10 USD のクレジット調整を適用します。 | 0 USD | 100 USD | 900 USD | 9,890 USD |
| クレジット期間末時点で、Gymbox は同社の長期顧客である Barbell に、そのロイヤルティに対して50 USD のステートメントクレジットを提供することを決定します。Gymbox は Barbell に対する 50 USD のクレジット調整を報告します。 | 0 USD | 50 USD | 950 USD | 9,890 USD |
| クレジット調整を送信した直後に、Gymbox はクレジットが大きすぎることに気づきます。Gymbox はステートメントクレジットを修正するために、Barbell の債務に対する 20 USD のデビット調整を報告します。 | 0 USD | 70 USD | 970 USD | 9,890 USD |
カード外取引アクティビティーのアカウント
Stripe は、支払いカードを使用するために登録したすべてのユーザーに対して、貸方元帳を自動的に作成します。時間の経過に伴い、連結アカウントには取引による支出が累積され、FundingObligations と利用可能なクレジットがそのカード支出アクティビティーに基づいて調整されます。調整を適用して、対応する貸方元帳エントリー (50 USD の顧客ロイヤリティ特典クレジットなど) を作成するには、次のコマンドを実行します。
レスポンスの例
{ "id": "cla_1IC5a2ILABoM8KJZ2EgdP4Tb", "object_type": "issuing_credit_ledger_adjustment", "reason": "platform_issued_credit_memo", "reason_description": "Customer loyalty reward credited to account", "amount": 5000, "currency": "usd", "funding_obligation": "fo_12345", "livemode": false }
次に、現在のクレジット期間にアカウントに対して行われたデビット調整とクレジット調整のリストを顧客に表示できます。これを行うには、stripe_ パラメーターと funding_ パラメーターを入力して credit_ エンドポイントを呼び出します。
レスポンスの例
{ "object": "list", "url": "/v1/issuing/credit_ledger_adjustments", "has_more": false, "data": [ { "id": "icla_1IC5a2ILABoM8KJZ2EgdP4Tb", "object_type": "issuing_credit_ledger_adjustment", "created": 1605236462, "amount": 50000, "currency": "usd", "reason": "platform_issued_credit_memo", "funding_obligation": "fo_12345", "livemode": false }, // ... more objects ] }
対応する FundingObligation の amount_ が、クレジット調整の金額分だけ減ったことを確認するため、FundingObligation を取得するか、または issuing_ Webhook をリッスンします。
FundingObligation の支出アクティビティーを取得する
カードに基づく取引のオーソリ、決済済みの取引、返済、カード外取引の調整にわたる支出アクティビティーを 1 つの明細書にまとめるには、credit_ エンドポイントを呼び出します。funding_obligation リクエストパラメーター内に債務 ID を指定します。
レスポンスの例
{ "object": "list", "url": "/v1/issuing/credit_ledger_entries", "has_more": false, "data": [ { "id": "cle_1IC6b2ILABoM8KZz3EgtT9ka", "object": "credit_ledger_entry", "created": 1615292400, "amount": -80000, "currency": "usd", "funding_obligation": "fo_12345", "livemode": true, "source": { "issuing_transaction": "ipi_1Fq2s1ILABoM8KZjPhQNaz2s", "type": "issuing_transaction" } }, { "id": "cle_1IC6b2ILABoM8KZz3EgwX7yp", "object": "credit_ledger_entry", "created": 1615206000, "amount": 20000, "currency": "usd", "funding_obligation": "fo_23456", "livemode": true, "source": { "issuing_credit_ledger_adjustment": "icla_1Fq8f2ILABoM8KZwSpPJz20F", "type": "issuing_credit_ledger_adjustment" } }, // ... more objects if available ] }
カードに基づく取引は issuing_ タイプでマークされ、調整は issuing_ タイプでマークされます。
あるいは、貸方元帳の調整をまだ行っていない場合、連結アカウントの FundingObligation に関連した取引のリストを取得できます。これを実行するには、次のように List all transactions API リクエストで funding_obligation_for_account パラメーターを渡します。
レスポンスの例
{ "object": "list", "url": "/v1/issuing/transactions", "has_more": false, "data": [ { "id": "ipi_123", "object": "issuing.transaction", // various other fields "funding_obligation_for_platform": "ifo_123", "funding_obligation_for_account": "ifo_456", // various other fields }, { "id": "ipi_123", "object": "issuing.transaction", // various other fields "funding_obligation_for_platform": "ifo_789", "funding_obligation_for_account": "ifo_456", // various other fields }, {...} ] }
Webhook のサマリー
次の 3 つの Webhook を監視できます。
issuing_:funding_ obligation. created FundingObligationが作成されるたびにトリガーされます。これは、連結アカウントの新しいクレジット期間のはじめに生じます。issuing_:funding_ obligation. updated FundingObligationが更新されるたびにトリガーされます。これは、資金追加の義務のステータスまたは金額のフィールドが変更されるか、返済を示すように更新されるたびに生じます。issuing_:credit_ ledger_ adjustment. created FundingObligationに対する新しい調整が作成されるたびにトリガーされます。