Switch gateway account

Idempotency Supported

Moves a card payment source from one gateway account to another.

Use this operation to migrate payment methods between gateway accounts, such as when:

consolidating gateway accounts
switching from Spreedly to direct gateway integration
aligning payment sources with regional/business unit gateway configurations

Supported gateways

See the Use Cases section for the list of supported source-destination gateway combinations.

Impact on `reference_id`

This operation updates the reference_id attribute of the payment source. In case you are using this value for any downstream system integrations, you will need to update the reference_id for the payment source in the downstream system to the new value.

Prerequisites & Constraints

The payment_source.type must be card.
The destination payment gateway account must be active and not archived.

Impacts

Payment source

The following attributes are updated:
gateway_account_id
gateway
reference_id
The role (primary or backup) of the payment source is not changed.

Use Cases

Supported source-destination gateway combinations

The API supports only the following source-destination gateway combinations:

Source	Destination
Any of the gateways via Spreedly. These include Authorize.net, Bambora, BlueSnap, Moneris, Orbital (Chase Paymentech), Paymill, PayPal Payments Pro, PayPal Payflow Pro, SagePay, Worldline Online Payments, Worldpay.	Any of the gateways via Spreedly. OR Any of the following gateways: Stripe, Authorize.net (direct integration), Braintree, BlueSnap (direct integration), and Worldpay (direct integration).
PayPal Express Checkout	PayPal Commerce

Sample Request

URL Format

POST https://[site].chargebee.com/api/v2/payment_sources/{cust-payment-source-id}/switch_gateway_account

Input Parameters

gateway_account_id

required, string, max chars=50

The gateway account you want to switch to.

Returns

customerCustomer object

Resource object representing customer

payment_sourcePayment source object

Resource object representing payment_source