Happy Business Starts Here

Highlighted
Support SME

How to bulk update customer account's payment gateway?

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.

Screen Shot 2019-08-23 at 3.53.33 PM.png

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.

Screen Shot 2019-08-23 at 4.08.06 PM.png

Click to see Options for Case#2






If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

5 REPLIES 5
Support SME

Re: How to bulk update customer account's payment gateway?

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.

Screen Shot 2019-08-23 at 3.53.33 PM.png

 

 

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

Screen Shot 2019-08-26 at 3.56.41 PM.png

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)






If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

Support SME

Re: How to bulk update customer account's payment gateway?

Case#2

The old payment gateway is being specified under customer accounts' setting directly with payment gateway names.

Screen Shot 2019-08-23 at 4.08.06 PM.png

 

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:

Screen Shot 2019-08-23 at 6.42.57 PM.png

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

Screen Shot 2019-08-23 at 6.53.04 PM.png

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 

Screen Shot 2019-08-23 at 6.18.03 PM.png

3) update Task Name, Run Mode and select valid connection

Screen Shot 2019-08-23 at 6.24.24 PM.png

4) open the Advanced tab and upload the file saved from 1. and create the task

Screen Shot 2019-08-23 at 6.59.23 PM.png

Reference:

Generate a data Source Export

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

Screen Shot 2019-08-26 at 10.49.07 PM.png

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

Screen Shot 2019-08-26 at 10.54.25 PM.png

3) Click the Start Run button to start the bulk update and wait for the collection run to complete and check the result

Screen Shot 2019-08-26 at 10.55.14 PM.png

(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:

Starting a collection run

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

Screen Shot 2019-08-27 at 4.01.48 PM.png

CONDITION Tab

Screen Shot 2019-08-27 at 4.03.02 PM.png

4) add an Iterate step (On Success > Logic > Iterate) and configure it as below

Screen Shot 2019-08-27 at 4.05.50 PM.png

5) add an Update step (For Each > CRUD > Update) and configure it as below

Screen Shot 2019-08-27 at 4.07.22 PM.png

6) click the little triangle to run the workflow

Screen Shot 2019-08-27 at 4.07.55 PM.png

7) check RUN HISTORY tab and TASKS tab till workflow run completed

Screen Shot 2019-08-27 at 4.46.08 PM.png

 

Reference:

General steps for using Workflow

Workflow Tasks

 

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:

REST API - Query

REST API - Update

 






If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

Valued Scholar

Re: How to bulk update customer account's payment gateway?

It would be great if you also added how to do this via Zuora Workflow!

Support SME

Re: How to bulk update customer account's payment gateway?

Smiley Happy hi @tatyana, great suggestion!

steps using workflow as been added






If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

Valued Scholar

Re: How to bulk update customer account's payment gateway?

great, thank you!