POST /customers/{customer-id}/credit_card

Storing card after successful 3DS flow not supported in this API. Use create using Payment Intent API under Payemnt source to store the card after successful 3DS flow completion.

Adds or replaces card details of a customer. Updating card details replaces the present payment method.

Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable

If you are using Stripe gateway, you can use Stripe.js with your card update form.
If you are using Braintree gateway, you can use Braintree.js with your card update form.
You can also use our Hosted Pages based integration. Use our Hosted Page - Update Card API to generate a 'Update Card' Hosted Page link.

Note: For customers signed up before 1st March 2014, if the card's billing information is specified in the input, the customer's Billing Info (i.e Billing Address and vat_number) will also be replaced with the new values automatically.

Servers

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

Path parameters

Name	Type	Required	Description
`customer-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-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
`billing_addr2`	String	No	Address line 2, as available in card billing address.
`billing_addr1`	String	No	Address line 1, as available in card billing address.
`gateway`	String	No	Name of the gateway this card should be stored with. * ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. * bluesnap - BlueSnap is a payment gateway. * tco - 2Checkout is a payment gateway. * first_data_global - First Data Global Gateway Virtual Terminal Account * exact - Exact Payments is a payment gateway. * bluepay - BluePay is a payment gateway. * paypal_express_checkout - PayPal Express Checkout is a payment gateway. * nuvei - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. * eway - eWAY Account is a payment gateway. * metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. * paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. * razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. * global_payments - Global Payments is a payment service provider. * amazon_payments - Amazon Payments is a payment service provider. * dlocal - Dlocal provides payment solutions for global commerce by accepting local payment methods. * not_applicable - Indicates that payment gateway is not applicable for this resource. * windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. * checkout_com - Checkout.com is a payment gateway. * adyen - Adyen is a payment gateway. * braintree - Braintree is a payment gateway. * nmi - NMI is a payment gateway. * quickbooks - Intuit QuickBooks Payments gateway * wepay - WePay is a payment gateway. * worldpay - WorldPay is a payment gateway * paystack - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. * pay_com - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes. * wirecard - WireCard Account is a payment service provider. * chargebee_payments - Chargebee Payments gateway * sage_pay - Sage Pay is a payment gateway. * moneris_us - Moneris USA is a payment gateway. * pin - Pin is a payment gateway * authorize_net - Authorize.net is a payment gateway * elavon - Elavon Virtual Merchant is a payment solution. * paypal_pro - PayPal Pro Account is a payment gateway. * orbital - Chase Paymentech(Orbital) is a payment gateway. * paypal - PayPal Commerce is a payment gateway. * beanstream - Bambora(formerly known as Beanstream) is a payment gateway. * hdfc - HDFC Account is a payment gateway. * ingenico_direct - Worldline Online Payments is a payment gateway. * ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. * migs - MasterCard Internet Gateway Service payment gateway. * stripe - Stripe is a payment gateway. * vantiv - Vantiv is a payment gateway. * moneris - Moneris is a payment gateway. * bank_of_america - Bank of America Gateway * chargebee - Chargebee test gateway. * eway_rapid - eWAY Rapid is a payment gateway. * gocardless - GoCardless is a payment service provider. * mollie - Mollie is a payment gateway. * paymill - PAYMILL is a payment gateway. * balanced_payments - Balanced is a payment gateway * cybersource - CyberSource is a payment gateway. * ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion. 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"`
`number`	String	Yes	The credit card number without any format. If you are using Braintree.js, you can specify the Braintree encrypted card number here.
`ip_address`	String	No	The IP address of the customer. Used primarily for referral integration and EU VAT validation.
`first_name`	String	No	Cardholder's first name.
`tmp_token`	String	No	The single-use card token returned by vaults like Stripe/Braintree which act as a substitute for your card details. Before calling this API, you should have submitted your card details to the gateway and gotten this token in return. Note: Supported only for Stripe, Braintree and Authorize.Net. If this value is specified, there is no need to specify other card details (like number, cvv, etc).
`expiry_month`	Integer	Yes	Card expiry month.
`last_name`	String	No	Cardholder's last name.
`billing_state_code`	String	No	The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set `state_code` as `AZ` (not `US-AZ`). For Tamil Nadu (India), set as `TN` (not `IN-TN`). For British Columbia (Canada), set as `BC` (not `CA-BC`).
`billing_zip`	String	No	Postal or Zip code, as available in card billing address.
`expiry_year`	Integer	Yes	Card expiry year.
`cvv`	String	No	The card verification value (CVV). If you are using Braintree.js, you can specify the Braintree encrypted CVV here.
`billing_city`	String	No	City, as available in card billing address.
`billing_state`	String	No	The state/province name. Is set by Chargebee automatically for US, Canada and India If `state_code` is provided.
`billing_country`	String	No	The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code. Note : If you enter an invalid country code, the system will return an error. Brexit If you have enabled EU VAT in 2021 or later, or have manually enable the Brexit configuration, then `XI` (the code for United Kingdom -- Northern Ireland) is available as an option. .

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.