ChargebeeAPI

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

id
required, string, max chars=150

Identifier for PaymentIntent.

status
required, enumerated string

Current status of PaymentIntent.

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

Possible Enum Values
card

card

ideal

ideal

sofort

sofort

bancontact

bancontact

google_pay

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.

customer_id
required, 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 unique ID of the business entity of this payment_intent

active_payment_attempt
optional, payment_attempt

Active payment attempt for the PaymentIntent.

payment_attempts
optional, list of payment_attempt

List of payment attempts associated with this PaymentIntent. Each item in the list is a payment_attempt object, identical in structure to active_payment_attempt .