Charges
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | True | The Id of the charge. | |
Amount | Integer | False | The amount of the charge. | |
Currency | String | False | The currency of the charge. | |
CustomerId | String | False | The customer Id of the charge. | |
AmountRefunded | Integer | True | The amount in cents refunded. | |
ApplicationFee | String | False | The application fee (if any) for the charge. | |
ApplicationFeeAmount | Integer | False | The amount of the application fee (if any) for the charge. | |
BalanceTransaction | String | False | The Id of the balance transaction that describes the impact of this charge on your account balance . | |
BillingDetailsAggregate | String | True | Billing information associated with the payment method at the time of the transaction. | |
Captured | Boolean | False | Whether the charge was created without capturing. | |
CalculatedStatementDescriptor | String | True | The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. | |
Created | Datetime | True | The datetime the charge was created. | |
Description | String | False | The description of the charge. | |
Destination | String | False | The account (if any) the charge was made on behalf of. | |
Disputed | Boolean | False | Whether the charge has been disputed. | |
DisputeAggregate | String | True | The details about the dispute if the charge has been disputed. | |
FailureCode | String | False | The error code explaining the reason for the charge failure if available. | |
FailureMessage | String | False | The message to the user further explaining the reason for the charge failure if available. | |
FraudDetailsAggregate | String | False | Information on fraud assessments for the charge. | |
Invoice | String | False | The Id of the invoice this charge is for if one exists. | |
Livemode | Boolean | False | Whether the charge is in live mode. | |
MetadataAggregate | String | False | The charge metadata object. | |
Order | String | True | The Id of the order this charge is for if one exists. | |
OutcomeAggregate | String | True | Details about whether the payment was accepted, and why. See understanding declines for details. | |
Paid | Boolean | True | If the charge succeeded or was successfully authorized for later capture. | |
PaymentIntent | String | True | ID of the PaymentIntent associated with this charge, if one exists. | |
PaymentMethod | String | True | ID of the payment method used in this charge. | |
PaymentMethodDetailsAggregate | String | True | Details about the payment method at the time of the transaction. | |
ReceiptEmail | String | False | The email address that the receipt for this charge was sent to. | |
ReceiptNumber | String | False | The transaction number that appears on email receipts sent for this charge. | |
ReceiptURL | String | False | This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. | |
Refunded | String | False | Whether or not the charge has been fully refunded. | |
RefundsAggregate | String | False | The list of refunds that have been applied to the charge. | |
Review | String | False | ID of the review associated with this charge if one exists. | |
ShippingAggregate | String | True | Shipping information for the charge. | |
SourceAggregate | String | False | The source of every charge is a credit or debit card. | |
SourceTransfer | String | False | The transfer Id that created this charge. | |
StatementDescriptor | String | False | The extra information about a charge. | |
Status | String | False | The status of the payment is either succeeded, pending, or failed. | |
Transfer | String | False | The Id of the transfer to the destination account. | |
TransferDataAggregate | String | True | An optional dictionary including the account to automatically transfer to as part of a destination charge. | |
TransferGroup | String | True | A string that identifies this transaction 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 |
AccountId | String | The Id of the connected account to get charges for |
Last updated