Payment intents

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.

Sample Payment intentJSON

Payment intents attributes

required, string, max chars=150

Identifier for PaymentIntent.

status

required, enumerated string

Current status of PaymentIntent.

Enum Values

inited

Intent is initialized.

in_progress

Status will be in_progress if the Active Payment Attempt state is in requires_identification, requires_challenge or requires_redirection.

authorized

3DS verification successfully completed.

consumed

If 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.

expired

Intent 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

required, in cents, min=0

Amount(in cents) to be authorized for 3DS flow.

gateway_account_id

optional, string, max chars=50

The gateway account used for performing the 3DS flow.

expires_at

required, 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

Enum Values

card

ideal

sofort

bancontact

google_pay

success_url

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

required, timestamp(UTC) in seconds

Timestamp indicating when the PaymentIntent was created.

modified_at

required, 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.

payment_method_options

optional, jsonobject

Options used to process the payment method. This attribute is omitted when no preference is stored.

card: Options for card payments.
- three_d_secure: Options for 3DS authentication.
  - challenge_preference: The preferred 3DS flow. Applicable only when payment_method_type is card and 3DS is enabled for the gateway account. Supported for Stripe, Adyen, and BlueSnap; ignored for other gateways. The gateway or card issuer can override the preference.
    - no_preference: Chargebee, the gateway, and the issuer decide the 3DS flow.
    - no_challenge: A frictionless flow without a challenge is requested.
    - challenge: A challenge flow is requested.

customer_id

optional, string, max chars=50

The unique identifier of the customer for whom the payment_intent will be created. If specified, the payment_intent will be used exclusively for that customer. If not specified, the payment_intent won't be associated with any customer and will be available for any customer.

See also

Customer resource lookup and creation

gateway

optional, string

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.

Note

Multiple Business Entities is a feature available only on Product Catalog 2.0.

brand_id

optional, string, max chars=50

The unique ID of the brand this payment intent belongs to. Unless a brand was specified in the request, this is the brand of the customer the payment intent was created for.

active_payment_attempt

Active payment attempt for the PaymentIntent.

payment_attempts

List of payment attempts associated with this PaymentIntent. Each item in the list is a payment_attempt object that shares the same structure as active_payment_attempt, except for the routing_rule_id and payment_method_display_rule_id attributes, which are returned only on active_payment_attempt.

payment_intent_metadata

Details about the client and the request that Chargebee captured when the payment intent was confirmed.