charges docs
This commit is contained in:
Pablo Martin
parent
0805cdb15c
commit
fb13ffebb2
2 changed files with 77 additions and 56 deletions
|
|
@ -38,10 +38,10 @@ sources:
|
|||
description: "The transaction’s net funds status in the Stripe balance, which are either available or pending."
|
||||
- name: created
|
||||
data_type: bigint
|
||||
description: "Time at which the object was created. Measured in seconds since the Unix epoch."
|
||||
description: "{{ doc('stripe_created_desc') }}"
|
||||
- name: currency
|
||||
data_type: character varying
|
||||
description: "Three-letter ISO currency code, in lowercase. Must be a supported currency."
|
||||
description: "{{ doc('stripe_currency_desc') }}"
|
||||
- name: description
|
||||
data_type: character varying
|
||||
description: "An arbitrary string attached to the object. Often useful for displaying to users."
|
||||
|
|
@ -71,169 +71,173 @@ sources:
|
|||
description: "{{ doc('_airbyte_meta_desc') }}"
|
||||
- name: charges
|
||||
identifier: charges
|
||||
description: |
|
||||
The Charge object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but transferring money to a different Stripe account through Connect also creates Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations.
|
||||
|
||||
You can read more about this object here: https://docs.stripe.com/api/charges.
|
||||
columns:
|
||||
- name: id
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('generic_id_desc') }}"
|
||||
- name: card
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc') }}"
|
||||
- name: paid
|
||||
data_type: boolean
|
||||
description: ""
|
||||
description: "true if the charge succeeded, or was successfully authorized for later capture."
|
||||
- name: order
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc') }}"
|
||||
- name: amount
|
||||
data_type: bigint
|
||||
description: ""
|
||||
description: "Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
|
||||
- name: object
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "Silly column. The value is always `charge`."
|
||||
- name: review
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "ID of the review associated with this charge if one exists."
|
||||
- name: source
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc') }}"
|
||||
- name: status
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "The status of the payment is either succeeded, pending, or failed."
|
||||
- name: created
|
||||
data_type: bigint
|
||||
description: ""
|
||||
description: "{{ doc('stripe_created_desc') }}"
|
||||
- name: dispute
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc')}}"
|
||||
- name: invoice
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "ID of the invoice this charge is for if one exists."
|
||||
- name: outcome
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "Details about whether the payment was accepted, and why. See understanding declines for details."
|
||||
- name: refunds
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "A list of refunds that have been applied to the charge."
|
||||
- name: updated
|
||||
data_type: bigint
|
||||
description: ""
|
||||
description: "{{ doc('stripe_created_desc')}}"
|
||||
- name: captured
|
||||
data_type: boolean
|
||||
description: ""
|
||||
description: "If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured."
|
||||
- name: currency
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('stripe_currency_desc') }}"
|
||||
- name: customer
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "ID of the customer this charge is for if one exists."
|
||||
- name: disputed
|
||||
data_type: boolean
|
||||
description: ""
|
||||
description: "Whether the charge has been disputed."
|
||||
- name: livemode
|
||||
data_type: boolean
|
||||
description: ""
|
||||
description: "Has the value true if the object exists in live mode or the value false if the object exists in test mode."
|
||||
- name: metadata
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "Additional properties supplied by Superhog."
|
||||
- name: refunded
|
||||
data_type: boolean
|
||||
description: ""
|
||||
description: "Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false."
|
||||
- name: shipping
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "Shipping information for the charge."
|
||||
- name: application
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc') }}"
|
||||
- name: description
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "An arbitrary string attached to the object. Often useful for displaying to users."
|
||||
- name: destination
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc') }}"
|
||||
- name: receipt_url
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "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."
|
||||
- name: failure_code
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "Error code explaining reason for charge failure if available (see the errors section for a list of codes)."
|
||||
- name: on_behalf_of
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details."
|
||||
- name: fraud_details
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "Information on fraud assessments for the charge."
|
||||
- name: receipt_email
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "This is the email address that the receipt for this charge was sent to."
|
||||
- name: transfer_data
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details."
|
||||
- name: amount_updates
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc') }}"
|
||||
- name: payment_intent
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "ID of the PaymentIntent associated with this charge, if one exists."
|
||||
- name: payment_method
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "ID of the payment method used in this charge."
|
||||
- name: receipt_number
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "This is the transaction number that appears on email receipts sent for this charge. This attribute will be null until a receipt has been sent."
|
||||
- name: transfer_group
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "A string that identifies this transaction as part of a group. See the Connect documentation for details."
|
||||
- name: amount_captured
|
||||
data_type: bigint
|
||||
description: ""
|
||||
description: "Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made)."
|
||||
- name: amount_refunded
|
||||
data_type: bigint
|
||||
description: ""
|
||||
description: "Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued)."
|
||||
- name: application_fee
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "The application fee (if any) for the charge. See the Connect documentation for details."
|
||||
- name: billing_details
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "Billing information associated with the payment method at the time of the transaction."
|
||||
- name: failure_message
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "Message to user further explaining reason for charge failure if available."
|
||||
- name: source_transfer
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details."
|
||||
- name: balance_transaction
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes)."
|
||||
- name: statement_descriptor
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "For card charges, use statement_descriptor_suffix instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters."
|
||||
- name: statement_description
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('field_docs_na_desc') }}"
|
||||
- name: application_fee_amount
|
||||
data_type: bigint
|
||||
description: ""
|
||||
description: The amount of the application fee (if any) requested for the charge. See the Connect documentation for details
|
||||
- name: payment_method_details
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "Details about the payment method at the time of the transaction."
|
||||
- name: failure_balance_transaction
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "ID of the balance transaction that describes the reversal of the balance on your account due to payment failure."
|
||||
- name: statement_descriptor_suffix
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor."
|
||||
- name: calculated_statement_descriptor
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "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."
|
||||
- name: _airbyte_raw_id
|
||||
data_type: character varying
|
||||
description: ""
|
||||
description: "{{ doc('_airbyte_raw_id_desc') }}"
|
||||
- name: _airbyte_extracted_at
|
||||
data_type: timestamp with time zone
|
||||
description: ""
|
||||
description: "{{ doc('_airbyte_extracted_at_desc') }}"
|
||||
- name: _airbyte_meta
|
||||
data_type: jsonb
|
||||
description: ""
|
||||
description: "{{ doc('_airbyte_meta_desc') }}"
|
||||
- name: payment_intents
|
||||
identifier: payment_intents
|
||||
columns:
|
||||
|
|
|
|||
17
models/staging/stripe/stripe_doc_blocks.md
Normal file
17
models/staging/stripe/stripe_doc_blocks.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
{% docs stripe_created_desc %}
|
||||
|
||||
Time at which the object was created. Measured in seconds since the Unix epoch.
|
||||
|
||||
{% enddocs %}
|
||||
|
||||
{% docs stripe_updated_desc %}
|
||||
|
||||
Time at which the object was last updated. Measured in seconds since the Unix epoch.
|
||||
|
||||
{% enddocs %}
|
||||
|
||||
{% docs stripe_currency_desc %}
|
||||
|
||||
Three-letter ISO currency code, in lowercase. Must be a supported currency.
|
||||
|
||||
{% enddocs %}
|
||||
Loading…
Add table
Add a link
Reference in a new issue