Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Credit a FinancialAddress object v2Test helper

Money Management
Financial Addresses
Credit a FinancialAddress object

Simulate crediting a FinancialAddress in a Sandbox environment. This can be used to add virtual funds and increase your balance for testing.

Learn more about calling API v2 endpoints.

Parameters

  • amountobjectRequired

    Object containing the amount value and currency to credit.

    • amount.currencystringRequired

      A lowercase alpha3 currency code like “usd”.

    • amount.valueintegerRequired

      In minor units like 123 for 1.23 USD.

  • idstringRequired

    The ID of the FinancialAddress to credit.

  • networkenumRequired

    The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.

    Possible enum values
    ach

    US - The Automated Clearing House (ACH) money movement.

    fps

    UK - Faster Payments System (FPS) money movement.

    rtp

    US - Real-Time Payments (RTP) money movement.

    wire

    A wire transfer money movement.

  • statement_descriptorstring

    String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.

Returns

Response attributes

  • objectstring, value is "financial_address_credit_simulation"

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

  • livemodeboolean

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

  • statusstring

    The status of the request, signifying whether a simulated credit was initiated.

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/credit
curl -X POST https://api.stripe.com/v2/test_helpers/financial_addresses/finaddr_test_61O6nHqDsFuMtECYR16O0lef0dSQgZ0EhGyZsQCXQMls/credit \
  -H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -H "Stripe-Version: 2025-04-30.preview" \
  --json '{
    "amount": {
        "value": 2500,
        "currency": "usd"
    },
    "network": "ach"
  }'
Response
{
  "object": "financial_address_credit_simulation",
  "status": "accepted"
}