Occasionally, our customers will need to upgrade their payment gateway to a new version. When that happens, sometimes it is also required to update the payment gateway setting of customer accounts to use the new payment gateway instance. Here is an introduction of some common approaches/tools to help.
Case#1
The previous payment gateway was the tenant level default payment gateway and all customer accounts using that payment gateway has option Use Default Gateway configured their payment gateway.
Click to see Option for Case#1
Case#2
The old payment gateway is being specified under customer accounts' setting directly with payment gateway names.
Case#1
The old payment gateway was the tenant level default payment gateway and all customer accounts using that payment gateway has option Use Default Gateway configured their payment gateway.
Please make sure to first test in Sandbox environment before making any change to Production environment.
Please configure your new payment gateway instance in Payment Gateway List page
https:/[domain name]apps/NewGatewaySetting.do?method=list
Click the [Make Default] for the newly configured payment gateway to change the new payment gateway to be the default one.
(no other action need to be executed under each customer account)
Case#2
The old payment gateway is being specified under customer accounts' setting directly with payment gateway names.
Option#1 Through Connect's Developer Tools(purchasable Marketplace App)
Please make sure to first test in Sandbox environment before making any change to Production environment.
1. Get account list which is using the old payment gateway instance
1) login to your Zuora Billing Service tenant and goto Reporting > Data Source Export
2) select "Account" to be the Data Source, select Fields and Filter as below:
3) click button "export", download and open the exported file
4) update the column header as below:
Account: ID --> Id
Account: Payment Gateway Name --> PaymentGateway
5) update the value of payment gateway name from the old payment gateway name to the new payment gateway name
e.g.
CyberSource API v1.97 --> CyberSource API v2.0
6) save the csv file
2. Use API Loader to bulk update the payment gateway for customer accounts
Please make sure to first test in Sandbox environment before making any change to Production environment.
1) go to Marketplace > Developer Tools
2) create New Task with type of
3) update Task Name, Run Mode and select valid connection
4) open the Advanced tab and upload the file saved from 1. and create the task
Reference:
Configure API Loader for Specific Zuora Objects
CSV Teamplate for Account&Contact
Option#2 Through 3rd Party REST API Client Tools
Please make sure to first test in Sandbox environment before making any change to Production environment.
Many of REST API client tools(e.g. Postman) have the feature to help customer execute REST API requests in bulk.
1. Get account list which is using the old payment gateway instance
(same as option#1, skip..)
2. Use Postman to bulk update the payment gateway for customer accounts
1) create an update request under a collection, make Id and PaymentGateway to be input params
2) start Postman's Collection Runner and select the Collection where your request is saved, select the file generated from 1 to be the Data File
3) Click the Start Run button to start the bulk update and wait for the collection run to complete and check the result
(Since this is an example of how to use a 3rd party tool, so we don't have further information about the limitation of records could be updated at a time and the expected performance)
Reference:
Lo oping through a data file in the Postman Collection Runner
Option#3 Through Workflow
Please make sure to first test in Sandbox environment before making any change to Production environment.
1) login to your Zuora Billing Service tenant and goto Platform > Workflow
2) Create a new workflow with a Blank template
3) Add a Query step (plus sign > On Start > Retrieve > Query) and configure it as below
FIELDS Tab
CONDITION Tab
4) add an Iterate step (On Success > Logic > Iterate) and configure it as below
5) add an Update step (For Each > CRUD > Update) and configure it as below
6) click the little triangle to run the workflow
7) check RUN HISTORY tab and TASKS tab till workflow run completed
Reference:
General steps for using Workflow
Option#4 Through Customized Script
Please make sure to first test in Sandbox environment before making any change to Production environment.
For customers having developing resources, we would also recommend using a customized script to finish the update and below are 2 API requests could help:
