API reference

Merchant management

 

Worldline FS Merchant Management module offers full and final merchant settlement based on Worldline FS: scheme clearing, scheme settlement files, merchant pricing engine, and merchant configuration as stored in the merchant contract system.

As trusted partner, Worldline FS manages the contract data of its clients’ customers.

  • Show merchant contract data in your application of preference.
  • Manage your own merchant contracts in real-time at all contract hierarchy levels in the merchant contract system.
  • Acquirers can allow third parties access to retrieve own merchant contract data and allow limited updating of own merchant contracts.

 

WL FS Acquiring Merchant Contract hierarchy:

  • Level 1: Acquirer (determined by the users access credentials)
  • Level 2: Holding
  • Level 3: Merchant (can be grouped)
  • Level 4: Contract
  • Level 5: Site (sub-Merchant, URL, Location)
  • Level 6: Terminal

 

Merchant management calls

The WL FS merchant contract API enables retrieval and updating at all contract hierarchy levels. For third parties, contract updating is limited depending the generic user role (e.g. PSP, PayFac, Merchant) limitations agreed with the acquiring bank.

You can retrieve data by providing key parameters (e.g. contractId, siteId, terminalid), and other search criteria such as IBAN.

There are two types of GET METHOD Contract calls:

  • GET calls to search (e.g. GET Holding List, GET Merchant List, GET Contract List, GET Site List, GET Terminal List) using one or more query parameters. Valid calls return a list with limited data.
  • GET calls to retrieve a specific entity return part of a contract entity (e.g. holding, merchant, contract, site, terminal).

 

In addition to retrieval, there are several METHODs which allow for contract Updating of own merchant contract data:

  1. Use POST call for adding a new contract entity (e.g. site, terminal).
  2. Use PATCH calls to change an existing contract call entity (e.g. addresses).
  3. Use DELETE calls to terminate (block) a contract call entity (e.g. site, terminal).


Parameters in bold are mandatory to complete a call.
To ensure best search call response time please use as many parameters as available.

 

Worldline Sandbox - Example set-up Payment Facilitator merchantId

 

 

 

 

Enable "on this page" menu on doc section
On