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.

get/v1/topups/{topup}

Request

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

Path parameters

topupstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

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

No operation changes found yet. Some revisions have not been checked.