Changing Payment Gateways or Processors for an Existing Ordergroove Integration

This article outlines the basic steps required for changing payment providers for your existing Ordergroove integration. If you are also changing ecommerce platforms, please refer to Platform Migrations Overview.

Note: Your specific integration may have additional nuances that need to be considered, so please reach out to your Ordergroove team ASAP if you are considering changing payment gateways. This process requires advance coordination with Ordergroove’s Solutions team to schedule the migration process required within Ordergroove.


Requirements

Due to the sensitive nature of payment information, you’ll likely be working with encrypted data and require engineering resources capable of safely managing and transforming this information, in addition to engineers capable of editing the payment flows for your ecommerce site.

Platform: A separate process applies when moving from Shopify draft order to contract APIs. Please reach out to your Ordergroove team for more information


Changing Payment Gateways

First, confirm your existing payment setup with Ordergroove. Please plan for the subscription program to be down during part of the migration process while Ordergroove updates payment tokens stored in our database.

Ordergroove Storing Payment Tokens

  1. Work with your current payment gateway to extract all payment details required for your new payment gateway and create the new payment records in the new gateway.
    • You’ll need to keep track of the old token IDs and provide a two-column CSV file to Ordergroove mapping the old token to the new token. This information is only required for customers with subscriptions.
  2. Disable new subscription creation and recurring order placement while performing the following tasks.
    • Update checkout flow to use new payment gateway for tokenization and include the new token in the Purchase Post API call made to Ordergroove
    • Update recurring order placement process to use new payment gateway
    • Update payment update API in the customer “My Account” section to use new payment gateway and send the new token to Ordergroove
    • Ordergroove runs script to update payment tokens using CSV file provided by the merchant
    • After running migration script, Ordergroove will manually place a recurring order to confirm successful order placement
  3. Enable subscription creation and recurring order placement
    • Create a new subscription via checkout to confirm successful subscription creation in Ordergroove
    • Edit your payment for an existing subscription to confirm Ordergroove receives the new token

Ordergroove Storing Customer ID as Token

Many older Ordergroove integrations use a “default” payment method in the ecommerce payment wallet; for these integrations, Orergroove is only storing the customer ID in lieu of a true token, with the merchant doing a lookup for the customer’s default payment record when recurring orders place. If you’re changing payment gateways, Ordergroove recommends moving the updated flow that utilizes true payment tokens.

  1. Work with your current payment gateway to extract all payment details required for your new payment gateway and create the new payment records in the new gateway.
    • Provide Ordergroove with a two-column CSV file containing the customer ID from your ecommerce platform and the token generated by your new payment gateway.  This information is only required for customers with subscriptions.
  2. Disable new subscription creation and recurring order placement while performing the following tasks.
    • Update checkout flow to use new payment gateway for tokenization and include the new token in the Purchase Post API call made to Ordergroove
    • Update recurring order placement process to use new payment gateway
    • Update payment update API in the customer “My Account” section to use new payment gateway and send the new token to Ordergroove
    • Ordergroove runs script to update payment tokens using CSV file provided by the merchant
    • After running migration script, Ordergroove will manually place a recurring order to confirm successful order placement
  3. Enable subscription creation and recurring order placement
    • Create a new subscription via checkout to confirm successful subscription creation in Ordergroove
    • Edit your payment for an existing subscription to confirm Ordergroove receives the new token