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

SourceReceiverFlow

object

address string

optionalnullable

The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

maxLength:5000

amount_charged integer

required

The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.

amount_received integer

required

The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.

amount_returned integer

required

The total amount that was returned to the customer. The amount returned is expressed in the source's currency.

refund_attributes_method string

required

Type of refund attribute method, one of `email`, `manual`, or `none`.

maxLength:5000

refund_attributes_status string

required

Type of refund attribute status, one of `missing`, `requested`, or `available`.

maxLength:5000

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"}