Merchant management
The WL FS Merchant Contract API enables retrieval and updating at all contract hierarchy levels. Access to contract data is restricted to your acquirer and own merchant contract identifiers. For third parties, contract updating is limited depending on the generic user role (e.g. PSP, PayFac, Merchant) limitations agreed with the acquiring bank.
Production release of Merchant Contract API version 2.0.3 is planned for 21-04-2024.
#version 2.0.3 (21-02-2024)
- Add field visaMerchantVolumeIndicator to existing calls:
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}
- Add fields matTransactionLimitContactless and matCardholderVerificationLimit to existing calls:
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/brands
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{siteId}/brands
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{siteId}/brands
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{siteId}/terminals/{terminalId}/brands
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{siteId}/terminals/{terminalId}/brands
#version 2.0.2 (28-06-2023)
- New Calls based on cardAcceptorId:
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/sites
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}
- DELETE /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}
- DELETE /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/addresses
- New Call:
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/currencies
- Add optional contractId to SITE entity in post body
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/sites
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites
-Add field paymentFacilitatorName to existing calls:
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}
#version 2.0.1 (02-12-2022)
- New Calls:
- POST /acquiring/contract/v2.0/acquirers/{acquirerId}/holdings
- PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}
- DELETE /acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}
- GET /acquiring/contract/v2.0/acquirers/{acquirerId}/terminals/{terminalId}/checknumbers/{checkNumber}
Version note:
Please be aware that these API interfaces may be changed and improved (e.g. addition of fields).
The "Try out" feature does not work at this time because the sandbox is being improved to support new functionality.
Merchant management
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.
Benefits for you!
Improve user experience
Provide this data in your application of preference to optimize your customer's journey.
Eliminate manual work
No need to log into the (separate) merchant portal anymore. Your customers can access the data in the application of preference
Easy access to real-time merchant contract data
Access your customer data in your own infrastructural environment.
Who can use the API?
Acquirers
PSPs
Why use it?
Currently the merchant can only retrieve contract data via a separate merchant portal. This API enables you to present the contract data in one place. You can use specific contract management information (e.g. merchantId, contractId) to call other Worldline FS APIs.
USE CASE
Provide customers all relevant contract data in one place
Imagine that – being a client of Worldline FS – you can now show all relevant Worldline FS merchant contract information in your own application. Moreover, you can combine this data with your own contract data to provide the client with all his contract data in one place.
Update your (sub-)merchant contract data
As a PSP you need to update the contact details for a (sub-)merchant. With this API - being a third party customer of Worldline FS - you can update the contract details (e.g. move terminal between sites or change contact phone number) on demand ensuring they are up-to-date. This helps you ensure a speedy service to your customers and lowers costs by reducing acquirer support calls.
How it works for a PSP
Step 1
-
Your (sub-)merchant logs in to your app or merchant portal and selects “View contract data”
-
Your (sub-)merchant selects the data he/she would like to see
-
Site is the contract hierarchy level of your (sub-)merchant (URL or location)
Step 2
-
Your app/merchant portal transfers the request to Worldline FS by using GET address at siteId call
-
The Worldline FS API returns the requested data in JSON format
-
Your app/merchant portal reformats and presents it to your (sub-)merchant
Step 3
-
Your merchant checks his/her information and selects "Edit" to update his/her contact details
-
He/she updates his contact phone number and selects "Save"
-
The contact details are sent by you via a PATCH address at siteId call to WL FS updating the details in the merchant contract database real-time