A payment_intent is created to help you navigate the 3DS flow of collecting payment from your customer. It is necessary only for implementing 3DS flow using Chargebee.js.
Auto-expiry
All payment_intents with status as inited, in_progress or authorized become expired after an hour automatically.
string, max chars=150 Identifier for PaymentIntent.
status
enumerated string Current status of PaymentIntent.
Possible values are
initedIntent is initialized.in_progressStatus will be in_progress if the Active Payment Attempt state is in requires_identification, requires_challenge or requires_redirection.authorized3DS verification successfully completed.consumedIf any Chargebee operation such as create subscription etc. is completed using the intent, it will be in consumed state. Intent cannot be used if it's already in consumed state.expiredIntent has expired, since it was not consumed before the predefined time-out.
currency_code
optional, string, max chars=3 The currency code (ISO 4217 format) of the amount used in transaction.
amount
in cents, min=0 Amount(in cents) to be authorized for 3DS flow.
gateway_account_id
string, max chars=50 The gateway account used for performing the 3DS flow.
expires_at
timestamp(UTC) in seconds Timestamp indicating when the PaymentIntent will expire if left unconsumed.
reference_id
optional, string, max chars=200 Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.
payment_method_type
optional, enumerated string, default=card The payment method of this intent
optional, string, max chars=250 The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type is ideal, sofort, dotpay or giropay.
failure_url
optional, string, max chars=250 The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type is ideal, sofort, dotpay or giropay.
created_at
timestamp(UTC) in seconds Timestamp indicating when the PaymentIntent was created.
modified_at
timestamp(UTC) in seconds Timestamp indicating when the PaymentIntent was last modified.
resource_version
optional, long Version number of this resource. The resource_version is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
updated_at
optional, timestamp(UTC) in seconds Timestamp indicating when this payment intent was last updated.
customer_id
string, max chars=50
The unique ID of the customer for which this payment_intent should be created. If not provided, a new customer is created and its ID is autogenerated.
optional, string, max chars=null Gateway associated with the PaymentIntent.
business_entity_id
optional, string, max chars=50 The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
optional, payment_attempt Active payment attempt for the PaymentIntent.
Active payment attempt attributes
id
optional, string, max chars=70 Identifier for PaymentIntent's active payment attempt.
status
enumerated string Current status of active payment attempt
Possible values are
initedPayment attempt is initialized.requires_identificationCustomer's device fingerprint is used to verify their identity. It needs to be sent to the Issuing Bank for verification.requires_challengeThe transaction has to go through 3DS Challenge flow and the customer needs to authenticate via 3DS 2.0requires_redirectionThe transaction has to go through 3DS Redirection flow and the customer needs to authenticate via 3DS 1.0authorized3DS verification successfully completed.refused3DS verification attempt failed.pending_authorizationWaiting for the authorization.
payment_method_type
optional, enumerated string, default=card The payment method of this attempt
Creates a PaymentIntent object. This is to be used with Chargebee.js API to complete the 3DS flow for new or stored cards.
While creating, specify the appropriate gateway account and amount. Exact amount can be estimated using our Estimate API.
Customer resource lookup and creation
When customer[id] is provided for this operation, it is looked up by Chargebee, and if found, the payment_intent is created for it. If not found, a new customer resource is created with the ID provided, and the payment_intent is created.
required, in cents, min=0 Amount(in cents) to be authorized for 3DS flow.
currency_code
required, string, max chars=3 The currency code (ISO 4217 format) of the amount used in transaction.
gateway_account_id
optional, string, max chars=50 The gateway account used for performing the 3DS flow.
reference_id
optional, string, max chars=200 Reference for payment method at gateway. Only applicable when the PaymentIntent is created for cards stored in the gateway.
payment_method_type
optional, enumerated string, default=card The payment method of this intent.
optional, string, max chars=250 The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type is ideal, sofort, dotpay or giropay.
failure_url
optional, string, max chars=250 The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type is ideal, sofort, dotpay or giropay.
optional, string, max chars=250 The URL the customer will be directed to once 3DS verification is successful. Applicable only when payment_method_type is ideal, sofort, dotpay or giropay.
failure_url
optional, string, max chars=250 The URL the customer will be directed to when 3DS verification fails. Applicable only when payment_method_type is ideal, sofort, dotpay or giropay.