TopUps
Represents top-ups of the Stripe balance, including the amount, currency, source, and status details.
Table-Specific Information
SELECT
The component uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the component.
| Column | Supported Operators |
| Id | = |
| Amount | = |
| Created | >, >=, <, <=, = |
| Status | = |
| AccountId | = |
You can select from the TopUps table with the following queries:
SELECT * FROM TopUps WHERE Id = '123124'
SELECT * FROM TopUps WHERE Amount = 1500
SELECT * FROM TopUps WHERE Created >= '2023-07-14T05:36:46.000-04:00'
SELECT * FROM TopUps WHERE Status = 'succeeded'
INSERT
To create a new topup, at least Amount and Currency are required:
INSERT INTO TopUps (Amount, Currency, Description) values (500, 'USD', 'This is the first topup of 5000 USD.')
UPDATE
To modify a topup, specify the Id:
UPDATE TopUps SET Description = 'This is the initial topup of 500 USD.' WHERE Id = '123124'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The unique identifier for the top-up. | |
| Amount | Integer | False |
The amount transferred. | |
| BalanceTransaction | String | True |
The Id of the balance transaction. | |
| Created | Datetime | True |
The time at which the top-up was created, measured in seconds since the Unix epoch. | |
| Currency | String | False |
A three-letter ISO currency code, in lowercase. | |
| Description | String | False |
The top-up description. | |
| ExpectedAvailabilityDate | Datetime | True |
The date the funds are expected to arrive in the Stripe account for payouts. | |
| FailureCode | String | True |
An error code explaining the reason for the top-up failure, if available. | |
| FailureMessage | String | True |
A message to the user that further explains the reason for the top-up failure, if available. | |
| Livemode | Boolean | True |
Indicates whether the object exists in live mode. Has the value true if the object exists in live mode, or the value false if the object exists in test mode. | |
| Metadata | String | False |
The set of key-value pairs that you can attach to the top-up. | |
| Source | String | True |
The source details of the Stripe user. | |
| StatementDescriptor | String | False |
Extra information about the top-up, displayed on the customer's statement. | |
| Status | String | True |
The status of the top-up is either canceled, failed, pending, reversed, or succeeded. | |
| TransferGroup | String | False |
A string that identifies this top-up as part of a group. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| SourceId | String |
The Id of a source to transfer funds from. This is a pseudocolumn only supported for insert. |
| AccountId | String |
The Id of the connected account to get top-ups for. |