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"}

Revoke a StripeBalanceDebitAgreement

POST / v1 / stripe_balance_debit_agreements /:id / revoke

Revokes a Stripe Balance Debit Agreement, preventing further use for creating payment methods.

Parameters

• id string Required The ID of the StripeBalanceDebitAgreement to revoke.

Returns

Returns the revoked 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": "revoked"}