Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

List all top-ups 

Returns a list of top-ups.

Parameters

  • statusstring

    Only return top-ups that have the given status. One of canceled, failed, pending or succeeded.

More parameters

  • amountobject

  • createdobject

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A dictionary containing the data property, which is an array of separate top-up objects. The number of top-ups in the array is limited to the number designated in limit. If no more top-ups are available, the resulting array will be empty.

GET /v1/topups
curl -G https://api.stripe.com/v1/topups \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/topups",
  "has_more": false,
  "data": [
    {
      "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
    }
  ]
}

Cancel a top-up 

Cancels a top-up. Only pending top-ups can be canceled.

Parameters

No parameters.

Returns

Returns the canceled top-up. If the top-up is already canceled or can’t be canceled, an error is returned.

POST /v1/topups/:id/cancel
curl -X POST https://api.stripe.com/v1/topups/tu_1NG6yj2eZvKYlo2C1FOBiHya/cancel \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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": "canceled",
  "transfer_group": null
}