Top-ups
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
The Top-up object
Attributes
- idstring
Unique identifier for the object.
- amountinteger
Amount transferred.
- currencystring
Three-letter ISO currency code, in lowercase. Must be a supported currency.
- descriptionnullable string
An arbitrary string attached to the object. Often useful for displaying to users.
- metadatadictionary
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.
- statusenum
The status of the top-up is either
canceled
,failed
,pending
,reversed
, orsucceeded
.
More attributes
- objectstring
- balance_
transactionnullable stringExpandable - createdtimestamp
- expected_
availability_ datenullable integer - failure_
codenullable string - failure_
messagenullable string - livemodeboolean
- sourcenullable dictionaryDeprecated
- statement_
descriptornullable string - transfer_
groupnullable string
Create a top-up
Top up the balance of an account
Parameters
- amountintegerRequired
A positive integer representing how much to transfer.
- currencystringRequired
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.
- metadatadictionary
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- sourcestring
- statement_
descriptorstring - transfer_
groupstring
Returns
Returns the top-up object.
Update a top-up
Updates the metadata of a top-up. Other top-up details are not editable by design.
Parameters
- descriptionstring
An arbitrary string attached to the object. Often useful for displaying to users.
- metadatadictionary
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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
Returns
The newly updated top-up object if the call succeeded. Otherwise, this call raises an error.
Retrieve a top-up
Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
Parameters
No parameters.
Returns
Returns a top-up if a valid identifier was provided, and raises an error otherwise.