Open Banking Direct Access

Version history

Search

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.

 

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.