POST /payment_intents/{payment-intent-id}

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

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`payment-intent-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`success_url`	String	No	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`.
`currency_code`	String	No	The currency code (ISO 4217 format) of the amount used in transaction.
`amount`	Integer	No	Amount(in cents) to be authorized for 3DS flow.
`gateway_account_id`	String	No	The gateway account used for performing the 3DS flow.
`payment_method_type`	String	No	The payment method of this intent. * google_pay - google_pay * boleto - boleto * apple_pay - apple_pay * faster_payments - Faster Payments * klarna_pay_now - Klarna Pay Now * ideal - ideal * amazon_payments - Amazon Payments * bancontact - bancontact * netbanking_emandates - netbanking_emandates * pay_to - PayTo * venmo - Venmo * card - card * dotpay - dotpay * giropay - giropay * upi - upi * sofort - sofort * sepa_instant_transfer - Sepa Instant Transfer * direct_debit - direct_debit * paypal_express_checkout - paypal_express_checkout Possible values: `"bancontact"` `"upi"` `"amazon_payments"` `"online_banking_poland"` `"direct_debit"` `"sofort"` `"boleto"` `"netbanking_emandates"` `"giropay"` `"paypal_express_checkout"` `"apple_pay"` `"pay_to"` `"venmo"` `"payconiq_by_bancontact"` `"card"` `"klarna_pay_now"` `"dotpay"` `"faster_payments"` `"sepa_instant_transfer"` `"google_pay"` `"ideal"` Default value: "card"
`failure_url`	String	No	The URL the customer will be directed to when 3DS verification fails. Applicable only when `payment_method_type` is `ideal`, `sofort`, `dotpay` or `giropay`.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.