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.

Sample Request

Sample Result[JSON]

URL Format

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

Input Parameters

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 .

Returns

payment_intent

Payment intent object

Resource object representing payment_intent