Update a payment intent

Idempotency Supported

Updating properties on a PaymentIntent object. All the subsequent 3DS transaction attempts will have the updated values.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/payment_intents/{payment-intent-id}

Input Parameters

amount

optional, in cents, min=0

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

currency_code

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

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.

If not specified, the existing preference is retained. To clear it, pass payment_method_options with no challenge_preference.

Returns

payment_intent

Payment intent object

Resource object representing payment_intent