Skip to main content

Set up and configure a Citi payment gateway instance

Zuora

Set up and configure a Citi payment gateway instance

  1. Last updated
  2. Save as PDF

Set up and configure a Citi payment gateway instance by using the information in this article, including the configuration procedure, descriptions of the configuration fields, and reference for testing the payment gateway.

Prerequisites

Enable the Citi payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.

Procedure 

Perform the following steps to set up and configure a Citi payment gateway instance:

  1. Click your username at the top right and navigate to Settings > Payments > Setup Payment Gateway. 
  2. On the Configure Gateway Instance tab, select CitiConnect from the Gateway Type drop-down list.
  3. Click Create Gateway.
  4. Complete the information for the gateway instance. See below for more information on the fields.
  5. Click Save Gateway Information after entering the necessary information.

Configuration fields 

Common configuration fields

The following are the common configuration fields you must specify for all gateways. See Setting Up Payment Gateways for the general information about setting up a payment gateway and specifying the values for the common fields: 

  • Name
  • Use Gateway Test Environment
  • Cards Accepted
  • Default Authorization Amount - This field is used only for credit card validation.
  • Verify new payment method (optional) - With this checkbox selected, the validate call is triggered for any supported payment method when a new payment method is created.
  • Verify updated payment method (optional) - With this checkbox selected, the validate call is triggered for any supported payment method when an existing payment method is updated.

Additional configuration fields

In addition to common fields, configure the following fields that are specific to the Citi payment gateway integration. Fields are required unless otherwise noted.

  • Client Id - ID provided by Citi to retrieve an OAuth token.
  • Client Secret - Password provided by Citi to retrieve an OAuth Token.
  • Account Name - Name of the bank account linked with Citi.
  • Account Type - Type of the bank account.
  • Account Number - Account number of the bank account linked with Citi.
  • Accounting Routing Number - Routing number of the bank account linked with Citi.
  • BIC (Optional) - Bank Identifier Code. This code identifies the originating bank as Citibank.
  • Address - Address of the bank account linked with Citi.
  • Country - Country of the bank account linked with Citi.
  • Citi Connet Client Id - The Client ID used for Gateway Reconciliation. 
  • Citi Connect Profile Id - RIP (Optional) - ID of the RIP file Profile. It is one of the identifiers for the Citi reconciliation file. This field is optional depending on the configuration at the Citi gateway end.
  • Citi Connect Profile Id - DIP (Optional) - ID of the DIP file Profile. It is one of the identifiers for the Citi reconciliation file. This field is optional depending on the configuration at the Citi gateway end.
  • Citi Connect Profile Id - REJECT (Optional) - ID of the REJECT file Profile. It is one of the identifiers for the Citi reconciliation file. This field is optional depending on the configuration at the Citi gateway end. 
  • SSL Keystore - The keystore that contains the certificate for the SSL connection.
  • SSL Keystore Password - The password for the SSL keystore.
  • Encryption Keystore - The keystore that contains the certificate for encryption.
  • Encryption Keystore Password - The password for the encryption keystore.
  • Digital Signature Alias - The alias of the certificate for the Digitial Signature that is within the encryption keystore.
  • Encryption Alias - The alias of Citi's public certificate within the encryption keystore.
  • Decryption Keystore - The keystore that contains the certificate for decryption.
  • Decryption Keystore Password - The password for the decryption keystore.
  • Decryption Keystore Alias - The alias of the certificate within the decryption keystore.
  • Reconciliation Username (Optional) - A username provided by Citi to access a mailbox for gateway reconciliation.
  • Enable gateway reconciliation (Optional) - Select to enable gateway reconciliation on this instance. For more information about this option, see Overview of Citi payment gateway integration.

Test the configuration 

We recommend that you test your payment gateway using both your payment gateway's test and production (live) environments.  Once you have completed testing in the gateway's test environment, it is recommended that you perform a test in your live production environment with a real credit card. If there are any differences in the configuration of your testing and production accounts, testing in production ensures your production merchant account is set up properly and can successfully connect to the production environment.

You can use the test card information and testing scenarios provided by the gateway vendor to test your integration. See Citi's Documentation for details.