Create a payment intent

Idempotency Supported

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, the payment_intent is created without any customer association and will be available for any customer.

Multiple business entities

If multiple business entities are created for the site, the customer resource lookup and creation happen within the context of the business entity specified in this API call. If no business entity is specified, the customer resource lookup is performed within the site context, and if not found, the resource is created for the default business entity of the site.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/payment_intents

Input Parameters

business_entity_id

optional, string, max chars=50

Sets the context for this operation to the business entity specified. Applicable only when multiple business entities have been created for the site. When this parameter is provided, the operation is able to read/write data associated only to the business entity specified. When not provided, the operation can read/write data for the entire site.

Note

An alternative way of passing this parameter is by means of a custom HTTP header.

See also

Customer resource lookup and creation.

brand_id

optional, string, max chars=50

The unique ID of the brand this payment intent should be linked to. Applicable only when multiple brands have been created for the site. An alternative way of passing this parameter is by means of the chargebee-brand-id custom HTTP header; when both are provided, they must specify the same brand.

Default behavior

When not provided, the payment intent is linked to the brand of the customer it is created for, or to the default brand defined for the site when no customer is specified.

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 .

amount

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.

defer_payment_method_type

optional, boolean, default=false

When set to true, the binding of the payment method type and related fields is deferred during intent creation. As a result, fields such as gateway_account_id, gateway, payment_method_type, and reference_id provided in this request will be ignored until the intent is updated with a selected payment method.

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 .

payment_method_options

optional, jsonobject

Payment method-specific options for this PaymentIntent. Only card is supported; keys for other payment method types are ignored.

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: Requests a frictionless flow without a challenge.
    - challenge: Requests a challenge flow.

Returns

payment_intent

Payment intent object

Resource object representing payment_intent