Generates microdeposits for a FinancialAddress v2Test helper

Money Management
Financial Addresses
Generates microdeposits for a FinancialAddress

Generates microdeposits for a FinancialAddress in a Sandbox environment.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    The id of the financial address to generate microdeposits for.

Returns

Response attributes

  • objectstring, value is "financial_address_generated_microdeposits"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • amountsarray of objects

    The amounts of the microdeposits that were generated.

    • amounts.currencystring

      A lowercase alpha3 currency code like “usd”.

    • amounts.valueinteger

      In minor units like 123 for 1.23 USD.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • statusenum

    The status of the request.

    Possible enum values
    accepted

    The microdeposits were successfully generated.

Error Codes
404not_found

The resource wasn’t found.

409idempotency_error

An idempotent retry occurred with different request parameters.

POST /v2/test_helpers/financial_addresses/:id/generate_microdeposits
curl -X POST https://api.stripe.com/v2/test_helpers/financial_addresses/finaddr_test_61O6nHqDsFuMtECYR16O0lef0dSQgZ0EhGyZsQCXQMls/generate_microdeposits \
-H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
-H "Stripe-Version: 2025-04-30.preview"
Response
{
"object": "financial_address_generated_microdeposits",
"amounts": [
{
"value": 24,
"currency": "usd"
},
{
"value": 46,
"currency": "usd"
}
],
"status": "accepted"
}