The StripeBalanceDebitAgreement object

Attributes

id string Unique identifier for the object.
object string, value is "stripe_balance_debit_agreement" String representing the object’s type. Objects of the same type share the same value.
financial _ account nullable string The ID of the financial account that is authorized to be debited.
livemode boolean Has the value true if the object exists in live mode or the value false if the object exists in test mode.
multi _ use nullable object If this is a multi_use debit agreement, this hash contains details about the agreement.
seller _ network _ business _ profile string The ID of the seller network business profile associated with this debit agreement.
single _ use nullable object If this is a single_use debit agreement, this hash contains details about the agreement.
status enum The status of the debit agreement. Possible enum values active The debit agreement is active and can be used to create payment methods. expired The debit agreement has expired due to single-use consumption. pending The debit agreement has been created and is pending activation. revoked The debit agreement has been revoked by the granting account.

{ "id": "sbda_1Na5YT2eZvKYlo2Ctn7SPPuy", "object": "stripe_balance_debit_agreement", "financial_account": "fa_1Na5YT2eZvKYlo2Ctn7SPPuy", "livemode": false, "multi_use": null, "seller_network_business_profile": "snbp_1Na5YT2eZvKYlo2Ctn7SPPuz", "single_use": { "amount": 1000, "currency": "usd" }, "status": "active"}

Create a StripeBalanceDebitAgreement

POST / v1 / stripe_balance_debit_agreements

Creates a Stripe Balance Debit Agreement granting permission to debit from a financial account’s balance via the Stripe Balance payment method. The returned token can be used in payment_method_options[stripe_balance][mandate_options] to generate a payment method and mandate.

Parameters

seller _ network _ business _ profile string Required The ID of the seller network business profile being granted permission to debit.
financial _ account string The ID of the financial account to debit.
multi _ use object If this is a multi_use debit agreement, this hash contains details about the agreement.
single _ use object If this is a single_use debit agreement, this hash contains details about the agreement.

Returns

Returns a StripeBalanceDebitAgreement object.

cURL

Response

{ "id": "sbda_1Na5YT2eZvKYlo2Ctn7SPPuy", "object": "stripe_balance_debit_agreement", "financial_account": "fa_1Na5YT2eZvKYlo2Ctn7SPPuy", "livemode": false, "multi_use": null, "seller_network_business_profile": "snbp_1Na5YT2eZvKYlo2Ctn7SPPuz", "single_use": { "amount": 1000, "currency": "usd" }, "status": "pending"}

Retrieve a StripeBalanceDebitAgreement

GET / v1 / stripe_balance_debit_agreements /:id

Retrieves a Stripe Balance Debit Agreement by its ID.

Parameters

id string Required The ID of the StripeBalanceDebitAgreement to retrieve.

Returns

Returns a StripeBalanceDebitAgreement object.

cURL

Response

{ "id": "sbda_1Na5YT2eZvKYlo2Ctn7SPPuy", "object": "stripe_balance_debit_agreement", "financial_account": "fa_1Na5YT2eZvKYlo2Ctn7SPPuy", "livemode": false, "multi_use": null, "seller_network_business_profile": "snbp_1Na5YT2eZvKYlo2Ctn7SPPuz", "single_use": { "amount": 1000, "currency": "usd" }, "status": "active"}