Skip to main content
Manja / Stripe
Schema2020-08-27object

topup

To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID. Related guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

Topup

object

To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID. Related guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups).

amount integer
required

Amount transferred.

balance_transaction
optionalnullable

ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.

created integer (unix-time)
required

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

currency string
required

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

maxLength:5000

description string
optionalnullable

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

maxLength:5000

expected_availability_date integer
optionalnullable

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_code string
optionalnullable

Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).

maxLength:5000

failure_message string
optionalnullable

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

maxLength:5000

id string
required

Unique identifier for the object.

maxLength:5000

livemode boolean
required

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

metadata object
required

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

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

Allowed: "topup"

source Source object
required

`Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).

statement_descriptor string
optionalnullable

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

maxLength:5000

status string
required

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

Allowed: "canceled""failed""pending""reversed""succeeded"

transfer_group string
optionalnullable

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

maxLength:5000