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

source_type_klarna

object

background_image_url string

optional

client_token string

optionalnullable

first_name string

optional

last_name string

optional

locale string

optional

logo_url string

optional

page_title string

optional

pay_later_asset_urls_descriptive string

optional

pay_later_asset_urls_standard string

optional

pay_later_name string

optional

pay_later_redirect_url string

optional

pay_now_asset_urls_descriptive string

optional

pay_now_asset_urls_standard string

optional

pay_now_name string

optional

pay_now_redirect_url string

optional

pay_over_time_asset_urls_descriptive string

optional

pay_over_time_asset_urls_standard string

optional

pay_over_time_name string

optional

pay_over_time_redirect_url string

optional

payment_method_categories string

optional

purchase_country string

optional

purchase_type string

optional

redirect_url string

optional

shipping_delay integer

optional

shipping_first_name string

optional

shipping_last_name string

optional

Root JSON Schema

{"description":"To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping Up your Platform Account](https://stripe.com/docs/connect/top-ups).","properties":{"amount":{"description":"Amount transferred.","type":"integer"},"balance_transaction":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/balance_transaction"}],"description":"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.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/balance_transaction"}]}},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"currency":{"description":"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,"type":"string"},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","maxLength":5000,"nullable":true,"type":"string"},"expected_availability_date":{"description":"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.","nullable":true,"type":"integer"},"failure_code":{"description":"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,"nullable":true,"type":"string"},"failure_message":{"description":"Message to user further explaining reason for top-up failure if available.","maxLength":5000,"nullable":true,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"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.","type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["topup"],"type":"string"},"source":{"$ref":"#/components/schemas/source"},"statement_descriptor":{"description":"Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.","maxLength":5000,"nullable":true,"type":"string"},"status":{"description":"The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.","enum":["canceled","failed","pending","reversed","succeeded"],"type":"string"},"transfer_group":{"description":"A string that identifies this top-up as part of a group.","maxLength":5000,"nullable":true,"type":"string"}},"required":["amount","created","currency","id","livemode","metadata","object","source","status"],"title":"Topup","type":"object","x-expandableFields":["balance_transaction","source"],"x-resourceId":"topup"}