Technical Description

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.

#version 2.1.4 (21-08-2026)

- New calls to manage price plans:

•    GET /acquiring/contract/v2.1/acquirers/{acquirerId}/transactionFeePricePlans
•    POST /acquiring/contract/v2.1/acquirers/{acquirerId}/transactionFeePricePlans
•    GET /acquiring/contract/v2.1/acquirers/{acquirerId}/transactionFeePricePlans/{transactionFeePricePlanId}
•    DELETE /acquiring/contract/v2.1/acquirers/{acquirerId}/transactionFeePricePlans/{transactionFeePricePlanId}
•    PATCH /acquiring/contract/v2.1/acquirers/{acquirerId}/transactionFeePricePlans/{transactionFeePricePlanId}

- Additional versions of existing calls, based on cardAcceptorId:

•    GET /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/balances
•    PATCH /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/balances
•    GET /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/brands
•    PATCH /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/brands
•    GET /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/balances
•    PATCH /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/balances
•    GET /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/brands
•    PATCH /acquiring/contract/v2.1/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/brands

- Add fields paymentFacilitatorIndicator and paymentFacilitatorModel to

•    GET /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}
•    POST /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}
•    PATCH /acquiring/contract/v2.1/acquirers/{acquirerId}/merchants/{merchantId}


#version 2.1.3 (19-07-2026)

- Add fields customerServiceTelephoneNumber and additionalContactInformation to

•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}/addresses
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses
•    POST /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses
•    PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
•    POST /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
•    PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/addresses
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/addresses
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses
•    POST /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites
•    PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/addresses
•    PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/addresses
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}/terminals/{terminalId}/addresses
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}/terminals/{terminalId}/addresses

- Add fields url and geoCoordinates to

•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites
•    POST /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites
•    POST /acquiring/contract/v2.0/acquirers/{acquirerId}/sites
•    PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts/{contractId}/sites/{siteId}
•    PATCH /acquiring/contract/v2.0/acquirers/{acquirerId}/sites/{cardAcceptorId}


#version 2.1.2 (27-11-2025)

- Add the following fields...

•    total-results
•    total-pages
•    current-page
•    page-size
•    search-criteria

...to the response headers of the following calls:

•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/holdings
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/contracts
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/sites
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/terminals


#version 2.1.1 (20-06-2025)

- Version change from 2.0.5 to 2.1.1 to be in sync with the apigee version

- New calls:

•    POST cluster /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/clusters
•    DELETE cluster /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/clusters/{clusterId}
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/clusters
•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/lists/{listName}

- Add fields clusterId and terminationDate to Response of

•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}

- Add field terminationDate to Response of...

•    GET /acquiring/contract/v2.0/acquirers/{acquirerId}/holdings/{holdingId}

- Bugfix: This endpoint now correctly returns a HTTP 201 status code as per the specification. Previously, it returned a HTTP 200

•    POST /acquiring/contract/v2.0/acquirers/{acquirerId}/merchants/{merchantId}/addresses


#Older versions have been removed from version history

---------------------------------------------------------------------------------------------------------------------

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.