ADO.NET Provider for Stripe

Build 23.0.8839

PaymentIntent

A PaymentIntent guides you through the process of collecting a payment from your customer.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Unique identifier for the object.

Amount Integer False

Amount intended to be collected by this PaymentIntent.

AmountDetailsTip String True

Amount Details Tip

AmountCapturable Integer True

Amount that can be captured from this PaymentIntent.

AmountReceived Integer True

Amount that was collected by this PaymentIntent.

ApplicationFeeAmount Integer False

The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owners Stripe account.

AutomaticPaymentMethodsEnabled Boolean False

Automatically calculates compatible payment methods

AutomaticPaymentMethodsAllowRedirects String False

Controls whether this PaymentIntent will accept redirect-based payment methods.

CanceledAt Datetime True

Populated when status is canceled, this is the time at which the PaymentIntent was canceled.

CancellationReason String True

Reason for cancellation of this PaymentIntent, either user-provided (duplicate, fraudulent, requested_by_customer, or abandoned) or generated by Stripe internally (failed_invoice, void_invoice, or automatic).

CaptureMethod String False

Controls when the funds will be captured from the customers account.

ClientSecret String True

The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

ConfirmationMethod String False

Possible enum values-automatic, manual

Created Datetime True

Time at which the object was created. Measured in seconds since the Unix epoch.

Currency String False

Three-letter ISO currency code, in lowercase.

Application String True

ID of the Connect application that created the PaymentIntent.

Customer String False

ID of the Customer this PaymentIntent belongs to, if one exists.

LatestCharge String True

The latest charge created by this payment intent.

PaymentMethod String False

ID of the payment method used in this PaymentIntent.

TransferDataDestination String False

The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.

OnBehalfOf String False

The account (if any) for which the funds of the PaymentIntent are intended.

Invoice String True

ID of the invoice that created this PaymentIntent, if it exists.

Review String True

ID of the review associated with this PaymentIntent, if any.

Description String False

An arbitrary string attached to the object. Often useful for displaying to users.

LastPaymentErrorCharge String True

For card errors, the ID of the failed charge.

LastPaymentErrorCode String True

For some errors that could be handled programmatically, a short string indicating the error code reported.

LastPaymentErrorDeclineCode String True

For some errors that could be handled programmatically, a short string indicating the error code reported.

LastPaymentErrorDocURL String True

A URL to more information about the error code reported.

LastPaymentErrorMessage String True

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

LastPaymentErrorParam String True

If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

LastPaymentErrorPaymentMethod String True

The PaymentMethod object for errors returned on a request involving a PaymentMethod.

LastPaymentErrorPaymentMethodType String True

If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

LastPaymentErrorType String True

The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

LiveMode Boolean True

Has the value true if the object exists in live mode or the value true if the object exists in test mode.

NextAction String True

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

Object String True

String representing the objects type. Objects of the same type share the same value.

PaymentMethodOptions String False

Payment-method-specific configuration for this PaymentIntent.

PaymentMethodTypes String False

The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

PaymentMethodConfigurationDetailsId String False

ID of the payment method configuration used.

PaymentMethodConfigurationDetailsParent String False

ID of the parent payment method configuration used.

ProcessingCard String True

If the PaymentIntents payment_method_types includes card, this hash contains the details on the processing state of the payment.

ProcessingType String True

Type of the payment method for which payment is in processing state, one of card.

ReceiptEmail String False

Set of key-value pairs that you can attach to an object.

MetadataAggregate String False

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

SetupFutureUsage String False

Indicates that you intend to make future payments with this PaymentIntents payment method.

ShippingAddressCity String False

City, district, suburb, town, or village..

ShippingAddressCountry String False

Two-letter country code

ShippingAddressline1 String False

Address line 1

ShippingAddressline2 String False

Address line 2

ShippingAddressPostalCode String False

ZIP or postal code.

ShippingAddressState String False

State, county, province, or region.

ShippingCarrier String False

The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

ShippingName String False

Recipient name.

ShippingPhone String False

Recipient phone (including extension).

ShippingTrackingNumber String False

The tracking number for a physical product, obtained from the delivery service.

StatementDescriptor String False

For non-card charges, you can use this value as the complete description that appears on your customers statements.

StatementDescriptorSuffix String False

Provides information about a card payment that customers see on their statements.

Status String True

Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.

TransferDataAmount Integer False

Amount intended to be collected by this PaymentIntent.

TransferGroup String False

A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Confirm Boolean

Set to true to attempt to confirm this PaymentIntent immediately. This column is supported in INSERT.

OffSession Boolean

Set to true to indicate that the customer isn�t in your checkout flow during this payment attempt and can�t authenticate. This parameter can only be used with confirm=true. This column is supported in INSERT.

ErrorOnRequiresAction Boolean

Set to true to fail the payment attempt if the PaymentIntent transitions into requires_action. Use this parameter for simpler integrations that don�t handle customer actions, such as saving cards without authentication. This parameter can only be used with confirm=true. This column is supported in INSERT.

Mandate String

ID of the mandate that�s used for this payment. This parameter can only be used with confirm=true. This column is supported in INSERT.

MandateDataCustomerAcceptanceType String

The type of customer acceptance information included with the Mandate. One of online or offline. This parameter can only be used with confirm=true. This column is supported in INSERT.

使用できる値は次のとおりです。online, offline

MandateDataCustomerAcceptanceAcceptedAt Datetime

The time at which the customer accepted the Mandate. This parameter can only be used with confirm=true. This column is supported in INSERT.

MandateDataCustomerAcceptanceOffline String

If this is a Mandate accepted offline, this hash contains details about the offline acceptance. This parameter can only be used with confirm=true. This column is supported in INSERT.

MandateDataCustomerAcceptanceOnlineIPAddress String

The IP address from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT.

MandateDataCustomerAcceptanceOnlineUserAgent String

The user agent of the browser from which the Mandate was accepted by the customer. This parameter can only be used with confirm=true. This column is supported in INSERT.

RadarOptionsSession String

A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. This column is supported in INSERT.

ReturnURL String

The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method�s app or site. This parameter can only be used with confirm=true. This column is supported in INSERT.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839