POST /customers/{customer-id}/switch_gateway
Switches the gateway in which customer's card information is stored.
This is applicable only if the payment method is "card".
This operation is not supported if the current gateway is Braintree or Stripe.
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 Valid values:
|
chargebee-event-actions |
String | No |
skip all actions to be done on the events Valid values:
|
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 Valid values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
gateway |
String | Yes |
Name of the gateway you want to switch to. * twikey - Twikey is a payment service provider that specializes in processing direct debit payments across the EU. * ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. * bluesnap - BlueSnap is a payment gateway. * jp_morgan - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different payment_source_type. 2Checkout is a payment gateway. * first_data_global - First Data Global Gateway Virtual Terminal Account * exact - Exact Payments is a payment gateway. * deutsche_bank - Deutsche Bank is the leading German bank with strong European roots and a global network. 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 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. Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses. 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 * solidgate - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. 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. Valid values:
|
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.