TopUps
Creates, updates, and queries the top-up of the Stripe balance.
Table Specific Information
Select
The provider 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 provider.
- Id supports the following operator: =.
- Amount supports the following operator: =.
- Created supports the following operators: >, >=, <, <=, =.
- Status supports the following operator: =.
- AccountId supports the following operator: =.
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 Id of the top-ups. | |
Amount | Integer | False |
The amount transferred. | |
BalanceTransaction | String | True |
The Id of the balance transaction. | |
Created | Datetime | True |
The time at which the object 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 reason for top-up failure if available. | |
FailureMessage | String | True |
A message to the user that further explains reason for top-up failure if available. | |
Livemode | Boolean | True |
true if the object exists in live mode and false if in test mode. | |
Metadata | String | False |
The set of key/value pairs that you can attach to a value list object. | |
Source | String | True |
The source details of the Stripe user. | |
StatementDescriptor | String | False |
Extra information about a top-up. | |
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. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
SourceId | String |
The ID of a source to transfer funds from. It is a psuedo column only supported for insert. |
AccountId | String |
The Id of the connected account to get topups for. |