Fund a test mode cash balance

Changed on

Create an incoming testmode bank transfer

post/v1/test_helpers/customers/{customer}/fund_cash_balance

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/test_helpers/customers/{customer}/fund_cash_balance
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

customerstring required

Request body application/x-www-form-urlencoded

amountinteger required

Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the smallest currency unit (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

expandstring[]

Specifies which fields in the response should be expanded.

referencestring

A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's reconciliation algorithm applies to different user inputs.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer_accountstring nullable

The ID of an Account representing a customer whose available cash balance changed as a result of this transaction.

ending_balanceinteger required

The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

net_amountinteger required

The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.

object'customer_cash_balance_transaction' required

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

type'adjusted_for_overdraft' | 'applied_to_payment' | 'funded' | 'funding_reversed' | 'refunded_from_payment' | 'return_canceled' | 'return_initiated' | 'transferred_to_balance' | 'unapplied_from_payment' required

The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.