Create a top-up
POST / v1 / topups
Top up the balance of an account
Parameters
- amount integer Required A positive integer representing how much to transfer.
- currency string Required Three-letter ISO currency code, in lowercase. Must be a supported currency.
- description string An arbitrary string attached to the object. Often useful for displaying to users.
- metadata map 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
- payment _ method string Preview feature
- payment _ method _ options object Preview feature
- source string
- statement _ descriptor string
- transfer _ group string
Returns
Returns the top-up object.
Response
{ "id": "tu_1NG6yj2eZvKYlo2C1FOBiHya", "object": "topup", "amount": 2000, "balance_transaction": null, "created": 123456789, "currency": "usd", "description": "Top-up for Jenny Rosen", "expected_availability_date": 123456789, "failure_code": null, "failure_message": null, "livemode": false, "source": null, "statement_descriptor": "Top-up", "status": "pending", "transfer_group": null}
Update a top-up
POST / v1 / topups /:id
Updates the metadata of a top-up. Other top-up details are not editable by design.
Parameters
- description string An arbitrary string attached to the object. Often useful for displaying to users.
- metadata map 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.
Response
{ "id": "tu_1NG6yj2eZvKYlo2C1FOBiHya", "object": "topup", "amount": 2000, "balance_transaction": null, "created": 123456789, "currency": "usd", "description": "Top-up for Jenny Rosen", "expected_availability_date": 123456789, "failure_code": null, "failure_message": null, "livemode": false, "source": null, "statement_descriptor": "Top-up", "status": "pending", "transfer_group": null, "metadata": { "order_id": "6735" }}
Retrieve a top-up
GET / v1 / topups /:id
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.
Response
{ "id": "tu_1NG6yj2eZvKYlo2C1FOBiHya", "object": "topup", "amount": 2000, "balance_transaction": null, "created": 123456789, "currency": "usd", "description": "Top-up for Jenny Rosen", "expected_availability_date": 123456789, "failure_code": null, "failure_message": null, "livemode": false, "source": null, "statement_descriptor": "Top-up", "status": "pending", "transfer_group": null}