Implementation guide

In order to use the merchant sync approach, please follow these steps:

  1. Fetch merchants, /v2/service-providers
  2. Fetch and match merchants according to the synchronization options below. After you’ve matched the merchants, you should have a resulting table similar to the image below where the available action and action method have augmented your merchants.
  3. Update your transaction overview page to include a call to action button based on the added information for the merchants.

Merging our merchants with your merchants

Synchronisation options

In order to know which merchant (and optionally, service) on our side matches your merchant and service, you should select a common identifier between the two. Our recommendation is to use identifiers in the following order of preference:

  1. Our id field on a specific merchant. After matching merchant and service, we guarantee that the identifier will not change.
  2. Any third-party identifier. As these are unlikely to change, they provide a good way of matching up merchants between us and the partner if they are available.
  3. The name of the merchant (and optionally, the name of the service). While often stable enough to use for matching, merchants do change names at times. Furthermore, the name in our system may not match the name being used in your system. So even though the names should match there could sometimes be problems with matching due to spelling differences between the systems.

The first option is only usable for syncing updates from already mapped merchants. For new merchants, you should primarily look at the third-party identifier and name attribute, then map this to your own merchant's name (either automatically or via a manual process).

What’s Next