POST /hosted_pages/update_payment_method

Using this API, you can request your customers to update their payment method details or change their payment method. This is used in scenarios like customers updating their payment methods before the end of trial or customers switching among payment methods.

When this API is invoked, it returns a hosted page URL. When the customers are directed to this URL, they will be able to change/update their payment methods.

Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments) that you offer your customers, they will find options to switch among the various methods of payment. Note:

If the card[gateway] parameter is passed, and the customer chooses Card as a payment method, then the card details are stored in the gateway which is passed. However, if the card[gateway] parameter is passed and the customer chooses PayPal Express Checkout/Amazon Payments as a payment method, the gateway passed will be ignored.
The option of embedding into an iframe is not supported for PayPal Express Checkout and Amazon Payments as customers are redirected to the respective website pages. Hence if you have PayPal Express Checkout/Amazon Payments configured and pass the parameter embed=true, this will result in an unsuccessful API request. Also, if you have all the three payment methods (Card, Paypal Express Checkout and Amazon Payments) configured and pass the parameter embed=true, the returned hosted page URL will show only Card Payment as a payment method.

Servers

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

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-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
`customer`	Object	No	Parameters for customer
`customer.id`	String	Yes	Identifier of the customer.
`redirect_url`	String	No	The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL. Although the customer will be redirected to the `redirect_url` after successful checkout, we do not recommend relying on it for completing critical post-checkout actions. This is because redirection may not happen due to unforeseen reasons. Chargebee recommends listening to appropriate webhooks such as subscription_created or invoice_generated to verify a successful checkout. Note : Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL. Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded This parameter is not applicable for iframe messaging.
`pass_thru_content`	String	No	You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
`cancel_url`	String	No	The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL. Note : Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL. Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled This parameter is not applicable for iframe messaging and in-app checkout.
`card`	Object	No	Parameters for card
`card.gateway`	String	No	Name of the gateway this payment source is stored with. * sage_pay - Sage Pay is a payment gateway. * wirecard - WireCard Account is a payment service provider. * balanced_payments - Balanced is a payment gateway * elavon - Elavon Virtual Merchant is a payment solution. * migs - MasterCard Internet Gateway Service payment gateway. * not_applicable - Indicates that payment gateway is not applicable for this resource. * paymill - PAYMILL is a payment gateway. * first_data_global - First Data Global Gateway Virtual Terminal Account * ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. * eway_rapid - eWAY Rapid is a payment gateway. * chargebee - Chargebee test gateway. * beanstream - Bambora(formerly known as Beanstream) is a payment gateway. * braintree - Braintree is a payment gateway. * tco - 2Checkout is a payment gateway. * bluepay - BluePay is a payment gateway. * paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. * eway - eWAY Account is a payment gateway. * pin - Pin is a payment gateway * paypal_pro - PayPal Pro Account is a payment gateway. * authorize_net - Authorize.net is a payment gateway * stripe - Stripe is a payment gateway. * worldpay - WorldPay is a payment gateway * nmi - NMI is a payment gateway. * hdfc - HDFC Account is a payment gateway. Possible values: `"balanced_payments"` `"first_data_global"` `"paymill"` `"bluepay"` `"paypal_payflow_pro"` `"wirecard"` `"nmi"` `"hdfc"` `"ogone"` `"stripe"` `"migs"` `"eway_rapid"` `"worldpay"` `"sage_pay"` `"beanstream"` `"tco"` `"paypal_pro"` `"braintree"` `"elavon"` `"chargebee"` `"pin"` `"eway"` `"authorize_net"`
`embed`	Boolean	No	If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page. Note : For in-app checkout, default is false. Default value: true
`iframe_messaging`	Boolean	No	If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess & onCancel callbacks. Note : This parameter is not applicable for in-app checkout. Default value: false

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.