Create a top-up

Changed on

Top up the balance of an account

post/v1/topups

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/topups
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body application/x-www-form-urlencoded

amountinteger required

A positive integer representing how much to transfer.

currencystring required

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

descriptionstring

An arbitrary string attached to the object. Often useful for displaying to users.

expandstring[]

Specifies which fields in the response should be expanded.

payment_methodstring

The ID of a PaymentMethod representing the payment method to be used for the top-up. A PaymentMethod of type us_bank_account can be used.

sourcestring

The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. While testing, this can be a test bank token (see Testing Top-ups).

statement_descriptorstring

Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.

transfer_groupstring

A string that identifies this top-up as part of a group.

Response

Successful response.

amountinteger required

Amount transferred.

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.

descriptionstring nullable

An arbitrary string attached to the object. Often useful for displaying to users.

expected_availability_dateinteger nullable

Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.

failure_codestring nullable

Error code explaining reason for top-up failure if available (see the errors section for a list of codes).

failure_messagestring nullable

Message to user further explaining reason for top-up failure if available.

idstring required

Unique identifier for the object.

initiated_by'stripe' | 'user' nullable

Indicates whether the top-up was initiated by Stripe or by the user.

livemodeboolean required

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

metadataobject required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object'topup' required

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

statement_descriptorstring nullable

Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.

status'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded' required

The status of the top-up is either canceled, failed, pending, reversed, or succeeded.

transfer_groupstring nullable

A string that identifies this top-up as part of a group.

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.