REST API V2 – 2.23.1

Version 2.21.0 to 2.23.1

What's New

`POST` /search-contracts

Global Search for Contracts (beta)

This API allows to search for contracts with an issuers list

`POST` /issuers/{issuerId}/customers/{customerReference}/contacts

Create Contact for a customer (beta)

The API creates a contact person belonging to a customer by providing information such as first name, name or date of birth. To create a contact, it is needed to provide:

The issuer ID
The customer reference or the issuer customer reference

`POST` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts

Create Contact for a customer by external reference (beta)

The API creates a contact person belonging to a customer by providing information such as first name, name or date of birth. To create a contact, it is needed to provide:

The issuer ID
The customer reference or the issuer customer reference

`PUT` /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}

Modify Contact for a customer (beta)

The API allows information of a contact of the company to be modified. To update a contact, it is needed to provide:

The issuer ID
The customer reference or the issuer customer reference (as company)
The contact reference All attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty.

`DELETE` /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}

Remove Contact for a customer (beta)

The API allows a contact of the company to be deleted. To remove a contact, it is needed to provide:

The issuer ID
The customer reference or the issuer customer reference (as company)
The contact reference

`PUT` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

Modify Contact for a customer by external reference (beta)

The API allows information of a contact of the company to be modified. To update a contact, it is needed to provide:

The issuer ID
The customer reference or the issuer customer reference (as company)
The contact reference All attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty.

`DELETE` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

Remove Contact for a customer by external reference (beta)

The API allows a contact of the company to be deleted. To remove a contact, it is needed to provide:

The issuer ID
The customer reference or the issuer customer reference (as company)
The contact reference

`POST` /search-operations

Global Search for Operations (beta)

The API provides possibility to retrieve a list of operations for one or several accounts and for one or several contracts, based on certain criteria. The criteria used are the following:

1st Group: - Issuer Company External Reference - Posting Account Identifier - Virtual Service Card External Reference - Virtual Service Card Number
2nd Group: - Transaction date range - Posting date range
3rd Group: - Reference amount range - Approval Code - Card Acceptor Name. this criteria accepts wildcards ('%' allows to achieve a search with only a partial input, 'Plat%', '%hill', 'Al%gang') - Operation Kinds

The rules of using this API and criteria for searching, are the following:

It will be mandatory to provide at least one of criteria from 1st Group. It is possible to provide two or three criteria at the same time. Virtual Service Card Number and Virtual Service Crad External Reference can not be provided at the same time
It will be mandatory to provide one criteria from 2nd Group. The two criterias can not be provided at the same time
All Criteria in 3rd Group are optional
Regarding Criteria that will include ranges, both minimum and maximum values should be provided

What's Changed

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}

Response:

Changed property data (object Order)
- Changed property card (object Card)
  - Changed property cardContract (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}

Response:

Changed property data (object Order)
- Changed property card (object Card)
  - Changed property cardContract (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/disputes/{disputeFolderReference}

Response:

Changed property data (object Dispute)
- Added property transmissionDate (string)
- Added property clientOpenDate (string)

`GET` /issuers/{issuerId}/operations/{externalOperationReference}/dispute

Response:

Changed property data (object Dispute)
- Added property transmissionDate (string)
- Added property clientOpenDate (string)

`GET` /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}

Response:

Changed property data (object Dispute)
- Added property transmissionDate (string)
- Added property clientOpenDate (string)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}

Response:

Changed property data (object Account)
- Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/accounts/{accountReference}

Response:

Changed property data (object Account)
- Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}

Response:

Changed property data (object Card)
- Changed property cardContract (object CardContract)
  - Added property productExtensionIdentifier (object)
  - Changed property cards (array)
    - Changed items (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
- Changed property orders (array)
  - Changed items (object Order)
    - Changed property card (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders

Response:

Changed property data (array)
- Changed items (object Order)
  - Changed property card (object Card)
    - Changed property cardContract (object CardContract)
      - Added property productExtensionIdentifier (object)
      - Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/{cardReference}

Response:

Changed property data (object Card)
- Changed property cardContract (object CardContract)
  - Added property productExtensionIdentifier (object)
  - Changed property cards (array)
    - Changed items (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
- Changed property orders (array)
  - Changed items (object Order)
    - Changed property card (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/{cardReference}/orders

Response:

Changed property data (array)
- Changed items (object Order)
  - Changed property card (object Card)
    - Changed property cardContract (object CardContract)
      - Added property productExtensionIdentifier (object)
      - Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/{cardReference}/disputes

Response:

Changed property data (array)
- Changed items (object Dispute)
  - Added property transmissionDate (string)
  - Added property clientOpenDate (string)

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/disputes

Response:

Changed property data (array)
- Changed items (object Dispute)
  - Added property transmissionDate (string)
  - Added property clientOpenDate (string)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}

Response:

Changed property data (object CardContract)
- Added property productExtensionIdentifier (object)
- Changed property cards (array)
  - Changed items (object Card)
    - Changed property cardContract (object CardContract)
      - Added property productExtensionIdentifier (object)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards

Response:

Changed property data (array)
- Changed items (object Card)
  - Changed property cardContract (object CardContract)
    - Added property productExtensionIdentifier (object)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}

Response:

Changed property data (object CardContract)
- Added property productExtensionIdentifier (object)
- Changed property cards (array)
  - Changed items (object Card)
    - Changed property cardContract (object CardContract)
      - Added property productExtensionIdentifier (object)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}/cards

Response:

Changed property data (array)
- Changed items (object Card)
  - Changed property cardContract (object CardContract)
    - Added property productExtensionIdentifier (object)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract

Response:

Changed property data (object CardContract)
- Added property productExtensionIdentifier (object)
- Changed property cards (array)
  - Changed items (object Card)
    - Changed property cardContract (object CardContract)
      - Added property productExtensionIdentifier (object)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`POST` /issuers/{issuerId}/cards/search

Response:

Changed property data (array)
- Changed items (object Card)
  - Changed property cardContract (object CardContract)
    - Added property productExtensionIdentifier (object)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/cards/{cardReference}/card-contract

Response:

Changed property data (object CardContract)
- Added property productExtensionIdentifier (object)
- Changed property cards (array)
  - Changed items (object Card)
    - Changed property cardContract (object CardContract)
      - Added property productExtensionIdentifier (object)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/contracts/{contractReference}/accounts

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/customers/{customerReference}/accounts

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/accounts/{accountReference}/contract

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/card-contracts/

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Added property productExtensionIdentifier (object)
  - Changed property cards (array)
    - Changed items (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}/contract

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property account (object Account)
  - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property account (object Account)
  - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property account (object Account)
  - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property account (object Account)
  - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Added property productExtensionIdentifier (object)
  - Changed property cards (array)
    - Changed items (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/contracts/{contractReference}

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property productExtensionIdentifier (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Added property productExtensionIdentifier (object)
    - Changed property cards (array)
      - Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/contracts/{contractReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Added property productExtensionIdentifier (object)
  - Changed property cards (array)
    - Changed items (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Added property productExtensionIdentifier (object)
  - Changed property cards (array)
    - Changed items (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/customers/{customerReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Added property productExtensionIdentifier (object)
  - Changed property cards (array)
    - Changed items (object Card)
      - Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}

Response:

Changed property data (object CorporateContract)
- Changed property rootAccount (object Account)
  - Added property productExtensionIdentifier (object)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property productExtensionIdentifier (object)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property productExtensionIdentifier (object)
    - Changed property cardContracts (array)
      - Changed items (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

Response:

Changed property data (object CorporateContract)
- Changed property rootAccount (object Account)
  - Added property productExtensionIdentifier (object)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property productExtensionIdentifier (object)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property productExtensionIdentifier (object)
    - Changed property cardContracts (array)
      - Changed items (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`POST` /issuers/{issuerId}/contracts/create-consumer-contract

Request body :

Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
- Changed property cardContracts (array)
  - Changed items (object CreateConsumerContractRequest.CardContract)
    - Added property cardContractSourceInheritance (object)

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Request body :

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Added property cardContractSourceInheritance (object)

`POST` /issuers/{issuerId}/contracts/search

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property productExtensionIdentifier (object)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Added property productExtensionIdentifier (object)
      - Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`POST` /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

Request body :

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Added property cardContractSourceInheritance (object)

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property productExtensionIdentifier (object)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Added property productExtensionIdentifier (object)
      - Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/customers/{customerReference}/contracts

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property productExtensionIdentifier (object)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Added property productExtensionIdentifier (object)
      - Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property rootAccount (object Account)
    - Added property productExtensionIdentifier (object)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property productExtensionIdentifier (object)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property productExtensionIdentifier (object)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`GET` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property rootAccount (object Account)
    - Added property productExtensionIdentifier (object)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property productExtensionIdentifier (object)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property productExtensionIdentifier (object)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`POST` /search-corporate-contracts

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property rootAccount (object Account)
    - Added property productExtensionIdentifier (object)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property productExtensionIdentifier (object)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property productExtensionIdentifier (object)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property cards (array)
        Changed items (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Changed property cardContract (object CardContract)
        Added property productExtensionIdentifier (object)

`POST` /issuers/{issuerId}/cards/pin-state

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/cards/{cardReference}/reset-pin-try-counter

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reset-pin-try-counter

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/companies/{customerReference}/contacts

Request body :

Added property firstName (string)
Added property type (string)
Added property birthDate (string)
Added property postalAddress (object)
Deleted property firstname (string)

`POST` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts

Request body :

Added property firstName (string)
Added property type (string)
Added property birthDate (string)
Added property postalAddress (object)
Deleted property firstname (string)

`PUT` /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}

Request body :

Added property firstName (string)
Added property type (string)
Added property birthDate (string)
Added property postalAddress (object)
Deleted property firstname (string)

`PUT` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

Request body :

Added property firstName (string)
Added property type (string)
Added property birthDate (string)
Added property postalAddress (object)
Deleted property firstname (string)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases/{businessCaseId}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`PUT` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`DELETE` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`PUT` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`DELETE` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases/{businessCaseId}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`PUT` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`DELETE` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`PUT` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`DELETE` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/cards/pin-state/{accountReference}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}

Response:

Changed property data (object Order)
- Changed property card (object Card)
  - Added property recovered (boolean)
  - Added property recoveryDate (string)
  - Added property lastSavingMeasureCode (string)
  - Changed property cardContract (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}

Response:

Changed property data (object Order)
- Changed property card (object Card)
  - Added property recovered (boolean)
  - Added property recoveryDate (string)
  - Added property lastSavingMeasureCode (string)
  - Changed property cardContract (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorizations/{authorizationId}

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-guarantor

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-owner

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

Request body :

Added property priority (integer)

`GET` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`PUT` /issuers/{issuerId}/companies/{customerReference}

Request body :

Added property contacts (array)

`PATCH` /issuers/{issuerId}/companies/{customerReference}

Request body :

Added property contacts (array)

`GET` /issuers/{issuerId}/companies/{customerReference}

Response:

Changed property data (object Company)
- Changed property contacts (array)
  - Changed items (object Contact)
    - Added property type (string)
    - Added property birthDate (string)
    - Added property postalAddress (object)
    - Deleted property contactReference (string)

`PUT` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}

Request body :

Added property contacts (array)

`PATCH` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}

Request body :

Added property contacts (array)

`GET` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}

Response:

Changed property data (object Company)
- Changed property contacts (array)
  - Changed items (object Contact)
    - Added property type (string)
    - Added property birthDate (string)
    - Added property postalAddress (object)
    - Deleted property contactReference (string)

`GET` /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}

Response:

Changed property data (object Company)
- Changed property contacts (array)
  - Changed items (object Contact)
    - Added property type (string)
    - Added property birthDate (string)
    - Added property postalAddress (object)
    - Deleted property contactReference (string)

`GET` /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}

Response:

Changed property data (object Company)
- Changed property contacts (array)
  - Changed items (object Contact)
    - Added property type (string)
    - Added property birthDate (string)
    - Added property postalAddress (object)
    - Deleted property contactReference (string)

`GET` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}

Response:

Changed property data (object Company)
- Changed property contacts (array)
  - Changed items (object Contact)
    - Added property type (string)
    - Added property birthDate (string)
    - Added property postalAddress (object)
    - Deleted property contactReference (string)

`GET` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}

Response:

Changed property data (object Company)
- Changed property contacts (array)
  - Changed items (object Contact)
    - Added property type (string)
    - Added property birthDate (string)
    - Added property postalAddress (object)
    - Deleted property contactReference (string)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}

Response:

Changed property data (object Card)
- Added property recovered (boolean)
- Added property recoveryDate (string)
- Added property lastSavingMeasureCode (string)
- Changed property cardContract (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)
- Changed property orders (array)
  - Changed items (object Order)
    - Changed property card (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders

Response:

Changed property data (array)
- Changed items (object Order)
  - Changed property card (object Card)
    - Added property recovered (boolean)
    - Added property recoveryDate (string)
    - Added property lastSavingMeasureCode (string)
    - Changed property cardContract (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/cards/{cardReference}

Response:

Changed property data (object Card)
- Added property recovered (boolean)
- Added property recoveryDate (string)
- Added property lastSavingMeasureCode (string)
- Changed property cardContract (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)
- Changed property orders (array)
  - Changed items (object Order)
    - Changed property card (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/cards/{cardReference}/orders

Response:

Changed property data (array)
- Changed items (object Order)
  - Changed property card (object Card)
    - Added property recovered (boolean)
    - Added property recoveryDate (string)
    - Added property lastSavingMeasureCode (string)
    - Changed property cardContract (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/contracts/{contractReference}/contract-owner

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`PUT` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}

Request body :

Added property contacts (array)

`PATCH` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}

Request body :

Added property contacts (array)

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}

Parameters:

Changed: embed in query

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`PUT` /issuers/{issuerId}/customers/{customerReference}

Request body :

Added property contacts (array)

`PATCH` /issuers/{issuerId}/customers/{customerReference}

Request body :

Added property contacts (array)

`GET` /issuers/{issuerId}/customers/{customerReference}

Response:

Changed property data (object Customer)
- Added property contactIdentifiers (array)
- Added property contacts (array)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorizations

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorizations

Parameters:

Added: WL-Username in header
Added: WL-Peer-ID in header

`POST` /issuers/{issuerId}/companies

Request body :

Changed property contacts (array)
- Changed items (object CreateContactRequest)
  - Added property type (string)
  - Added property birthDate (string)
  - Added property postalAddress (object)
  - Deleted property issuerId (string)
  - Deleted property contactReference (string)
  - Deleted property contactIdentifier (object)

`GET` /issuers/{issuerId}/companies

Response:

Changed property data (array)
- Changed items (object Company)
  - Changed property contacts (array)
    - Changed items (object Contact)
      - Added property type (string)
      - Added property birthDate (string)
      - Added property postalAddress (object)
      - Deleted property contactReference (string)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property recovered (boolean)
    - Added property recoveryDate (string)
    - Added property lastSavingMeasureCode (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property recovered (boolean)
  - Added property recoveryDate (string)
  - Added property lastSavingMeasureCode (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property recovered (boolean)
    - Added property recoveryDate (string)
    - Added property lastSavingMeasureCode (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}/cards

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property recovered (boolean)
  - Added property recoveryDate (string)
  - Added property lastSavingMeasureCode (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace

Request body :

Changed property replaceCardRequest (object ReplaceCardRequest)
- Changed property cardContract (object ReplaceCardRequest.CardContract)
  - Changed property cardHolder (object ModifyCustomerRequest)
    - Added property contacts (array)

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property recovered (boolean)
    - Added property recoveryDate (string)
    - Added property lastSavingMeasureCode (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace

Request body :

Changed property cardContract (object ReplaceCardRequest.CardContract)
- Changed property cardHolder (object ModifyCustomerRequest)
  - Added property contacts (array)

`POST` /issuers/{issuerId}/cards/search

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property recovered (boolean)
  - Added property recoveryDate (string)
  - Added property lastSavingMeasureCode (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/cards/{cardReference}/block-and-replace

Request body :

Changed property replaceCardRequest (object ReplaceCardRequest)
- Changed property cardContract (object ReplaceCardRequest.CardContract)
  - Changed property cardHolder (object ModifyCustomerRequest)
    - Added property contacts (array)

`GET` /issuers/{issuerId}/cards/{cardReference}/card-contract

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property recovered (boolean)
    - Added property recoveryDate (string)
    - Added property lastSavingMeasureCode (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/cards/{cardReference}/replace

Request body :

Changed property cardContract (object ReplaceCardRequest.CardContract)
- Changed property cardHolder (object ModifyCustomerRequest)
  - Added property contacts (array)

`GET` /issuers/{issuerId}/customers

Response:

Changed property data (array)
- Changed items (object Customer)
  - Added property contactIdentifiers (array)
  - Added property contacts (array)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

Response:

Changed property data (object Contract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/accounts/{accountReference}/contract

Response:

Changed property data (object Contract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/card-contracts/

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract

Response:

Changed property data (object Contract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}/contract

Response:

Changed property data (object Contract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity

Request body :

Changed property companies (array)
- Changed items (object CreateCorporateContractRequest.Company)
  - Changed property contacts (array)
    - Changed items (object CreateCorporateContractRequest.Contact)
      - Added property birthDate (string)
      - Added property postalAddress (object)

`POST` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity

Request body :

Changed property companies (array)
- Changed items (object CreateCorporateContractRequest.Company)
  - Changed property contacts (array)
    - Changed items (object CreateCorporateContractRequest.Contact)
      - Added property birthDate (string)
      - Added property postalAddress (object)

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

Response:

Changed property data (object Contract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/contracts/{contractReference}

Response:

Changed property data (object Contract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/contracts/{contractReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/customers/{customerReference}/card-contracts

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property recovered (boolean)
      - Added property recoveryDate (string)
      - Added property lastSavingMeasureCode (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}

Response:

Changed property data (object CorporateContract)
- Changed property contractCompanies (array)
  - Changed items (object Company)
    - Changed property contacts (array)
      - Changed items (object Contact)
        Added property type (string)
        Added property birthDate (string)
        Added property postalAddress (object)
        Deleted property contactReference (string)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property cardContracts (array)
      - Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

Response:

Changed property data (object CorporateContract)
- Changed property contractCompanies (array)
  - Changed items (object Company)
    - Changed property contacts (array)
      - Changed items (object Contact)
        Added property type (string)
        Added property birthDate (string)
        Added property postalAddress (object)
        Deleted property contactReference (string)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Added property contactIdentifiers (array)
    - Added property contacts (array)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property cardContracts (array)
      - Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/contracts/create-consumer-contract

Request body :

Changed property customers (array)
- Changed items (object CreateConsumerContractRequest.Customer)
  - Added property contacts (array)
  - Response:
  - Changed property data (object CreateConsumerContractResponse)
    - Changed property customers (array)
      - Changed items (object CreateConsumerContractResponse.Customer)
        Added property contacts (array)

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Request body :

Changed property customers (array)
- Changed items (object CreateConsumerContractRequest.Customer)
  - Added property contacts (array)
  - Response:
  - Changed property data (object AddCardsAccountsResponse)
    - Changed property customers (array)
      - Changed items (object CreateConsumerContractResponse.Customer)
        Added property contacts (array)

`POST` /issuers/{issuerId}/contracts/search

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Added property contactIdentifiers (array)
      - Added property contacts (array)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

Request body :

Changed property customers (array)
- Changed items (object CreateConsumerContractRequest.Customer)
  - Added property contacts (array)
  - Response:
  - Changed property data (object AddCardsAccountsResponse)
    - Changed property customers (array)
      - Changed items (object CreateConsumerContractResponse.Customer)
        Added property contacts (array)

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Added property contactIdentifiers (array)
      - Added property contacts (array)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/customers/{customerReference}/contracts

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Added property contactIdentifiers (array)
      - Added property contacts (array)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property contractCompanies (array)
    - Changed items (object Company)
      - Changed property contacts (array)
        Changed items (object Contact)
        Added property type (string)
        Added property birthDate (string)
        Added property postalAddress (object)
        Deleted property contactReference (string)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Added property contactIdentifiers (array)
      - Added property contacts (array)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`GET` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property contractCompanies (array)
    - Changed items (object Company)
      - Changed property contacts (array)
        Changed items (object Contact)
        Added property type (string)
        Added property birthDate (string)
        Added property postalAddress (object)
        Deleted property contactReference (string)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Added property contactIdentifiers (array)
      - Added property contacts (array)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /search-corporate-contracts

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property contractCompanies (array)
    - Changed items (object Company)
      - Changed property contacts (array)
        Changed items (object Contact)
        Added property type (string)
        Added property birthDate (string)
        Added property postalAddress (object)
        Deleted property contactReference (string)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Added property contactIdentifiers (array)
      - Added property contacts (array)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property recovered (boolean)
        Added property recoveryDate (string)
        Added property lastSavingMeasureCode (string)

`POST` /issuers/{issuerId}/corporate-contracts/create-corporate-contract

Request body :

Changed property companies (array)
- Changed items (object CreateCorporateContractRequest.Company)
  - Changed property contacts (array)
    - Changed items (object CreateCorporateContractRequest.Contact)
      - Added property birthDate (string)
      - Added property postalAddress (object)

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}

Parameters:

Changed property data (array)
- Changed items (object Operation)
  - Added property parentOperationIdentifier (object)
  - Added property virtualCardService (object)
  - Added property virtualServiceCardReference (string)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property parentOperationIdentifier (object)
  - Added property virtualCardService (object)
  - Added property virtualServiceCardReference (string)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property parentOperationIdentifier (object)
  - Added property virtualCardService (object)
  - Added property virtualServiceCardReference (string)

`GET` /issuers/{issuerId}/accounts/{accountReference}/operations

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property parentOperationIdentifier (object)
  - Added property virtualCardService (object)
  - Added property virtualServiceCardReference (string)

`GET` /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property parentOperationIdentifier (object)
  - Added property virtualCardService (object)
  - Added property virtualServiceCardReference (string)

`GET` /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property parentOperationIdentifier (object)
  - Added property virtualCardService (object)
  - Added property virtualServiceCardReference (string)

`GET` /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property parentOperationIdentifier (object)
  - Added property virtualCardService (object)
  - Added property virtualServiceCardReference (string)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

Parameters:

Changed: embed in query

`GET` /issuers/{issuerId}/accounts/{accountReference}/contract

Parameters:

Changed: embed in query

What's Deleted

No API deleted.

VoP Requesting PSP API

Read more about VoP Requesting PSP API

Requesting PSP API

API Reference

This API specification is a draft, pending the publication of the EPC rulebook first definitive version in September to incorporate minor necessary changes.

This API based service is for requesting PSPs in the Worldline VoP Hub ecosystem and EPC scheme. It allows to process the verification of a payee identity via a single request to the Worldline VoP Hub, based on identification data and account data entered bv the Requester (Payer) in any payment channel of the PSP.

Diagram of VoP processing steps for Requesting PSP role

Features

The service will route the request to the corresponding responding bank using its dedicated directory service, obtain or compute a matching result (depending on the source of account holder information data or direct match result), and return it to the requesting PSP under 3 seconds (or timeout).

The API supports name + IBAN matching (returning a corrected name in case of a close match) as well as additional identifiers when supported by the responding bank.

Process

The Requesting bank gathers information from the Requester (payer) about the subject of the VoP (Payee), before initiating a payment from any Sepa Credit Transfer channel.
The API client authenticates towards VoP Hub and sends a request containing the gathered identification data and account reference.
The VoP Hub routes the request to the corresponding responding bank, part of its reachable VoP interfaces.
The VoP Hub receives the match result or necessary account holder information from the responding PSP.
The API client receives the resulting API response, which may include the corrected name according to the responding bank, in case of close matches.
The Requester is informed of the matching result, applies potential corrections and proceeds with payment initiation.

API Security

Authentication: The Worldline VoP Hub uses an authentication service that adheres to the OIDC standard protocol.
For enhanced security, the client must present an (qualified) SSL certificate to authenticate and sign token requests with a (qualified) seal certificate.
Secure Communication: All communications utilize MTLS with TLS 1.2 or higher, ensuring that data in transit is secure.
Data Integrity: Each API request and response is signed using a detached JWS signature, ensuring the integrity and authenticity of the data exchanged.

VoP Responding PSP

Read more about VoP Responding PSP

Responding PSP

In the EPC VoP scheme

According to the EPC Document 218-23, "Verification Of Payee Scheme Rulebook" first version for public consultation :

The Responding PSP is the Participant that receives the VOP Request from the Requesting PSP and Instantly processes that VOP Request.
The Responding PSP is also obliged to Instantly send a VOP Response containing a matching result about the received details of the Payment Counterparty or another reason, back to the Requesting PSP.
The Responding PSP may also be the Payment Counterparty.

Worldline provides API and file exchange based services for scheme participants who need to fulfil this role and intend to comply with all its rules.

The following simplified diagram represents how the Worldline VoP services operate on behalf of Responding PSPs in the EPC scheme :

Services

To produce match results on behalf of the Responding PSP, Worldline needs access to account related information of the subject of the Verification of Payee.

Two services are available for that purpose, and are detailed at the following locations in this developer portal :

Responding PSP API : a real time API definition to expose account holder data to the Worldline VoP Services.
Account Data Management : an API or file exchange based service for responding PSPs to delegate the storage of account holder data to the Worldline VoP services, then used to produce match results when answering VoP requests.

API version 2.21.0

View Documentation

Read more about API version 2.21.0

VoP - Account Data Management API

View Documentation

Read more about VoP - Account Data Management API

VoP - Responding PSP API

View Documentation

Read more about VoP - Responding PSP API

VoP - Requesting PSP API

View Documentation

Read more about VoP - Requesting PSP API

Subscribe to

Referential WS Server

Referential WS Client

API version 2.23.1

REST API V2 – 2.23.1

REST API V2 – 2.23.1

What's New

POST /search-contracts

POST /issuers/{issuerId}/customers/{customerReference}/contacts

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts

PUT /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}

DELETE /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}

PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

DELETE /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

POST /search-operations

What's Changed

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}

GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}

GET /issuers/{issuerId}/disputes/{disputeFolderReference}

GET /issuers/{issuerId}/operations/{externalOperationReference}/dispute

GET /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}

GET /issuers/{issuerId}/accounts/{accountReference}

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders

GET /issuers/{issuerId}/cards/{cardReference}

GET /issuers/{issuerId}/cards/{cardReference}/orders

GET /issuers/{issuerId}/cards/{cardReference}/disputes

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/disputes

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards

GET /issuers/{issuerId}/card-contracts/{cardContractReference}

GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cards

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract

POST /issuers/{issuerId}/cards/search

GET /issuers/{issuerId}/cards/{cardReference}/card-contract

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts

GET /issuers/{issuerId}/contracts/{contractReference}/accounts

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts

GET /issuers/{issuerId}/customers/{customerReference}/accounts

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

GET /issuers/{issuerId}/accounts/{accountReference}/contract

GET /issuers/{issuerId}/card-contracts/

GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract

GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract

GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts

GET /issuers/{issuerId}/contracts/{contractReference}

GET /issuers/{issuerId}/contracts/{contractReference}/card-contracts

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts

GET /issuers/{issuerId}/customers/{customerReference}/card-contracts

GET /issuers/{issuerId}/corporate-contracts/{contractReference}

GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

POST /issuers/{issuerId}/contracts/create-consumer-contract

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

POST /issuers/{issuerId}/contracts/search

Response:

POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

GET /issuers/{issuerId}/customers/{customerReference}/contracts

GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

POST /search-corporate-contracts

POST /issuers/{issuerId}/cards/pin-state

Parameters:

POST /issuers/{issuerId}/cards/{cardReference}/reset-pin-try-counter

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reset-pin-try-counter

POST /issuers/{issuerId}/companies/{customerReference}/contacts

Request body :

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts

PUT /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}

PUT /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases/{businessCaseId}

PUT /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}

`POST` /search-contracts

`POST` /issuers/{issuerId}/customers/{customerReference}/contacts

`POST` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts

`PUT` /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}

`DELETE` /issuers/{issuerId}/customers/{customerReference}/contacts/{contactReference}

`PUT` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

`DELETE` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

`POST` /search-operations

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}

`GET` /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}

`GET` /issuers/{issuerId}/disputes/{disputeFolderReference}

`GET` /issuers/{issuerId}/operations/{externalOperationReference}/dispute

`GET` /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}

`GET` /issuers/{issuerId}/accounts/{accountReference}

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders

`GET` /issuers/{issuerId}/cards/{cardReference}

`GET` /issuers/{issuerId}/cards/{cardReference}/orders

`GET` /issuers/{issuerId}/cards/{cardReference}/disputes

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/disputes

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}/cards

`GET` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-contract

`POST` /issuers/{issuerId}/cards/search

`GET` /issuers/{issuerId}/cards/{cardReference}/card-contract

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts

`GET` /issuers/{issuerId}/contracts/{contractReference}/accounts

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts

`GET` /issuers/{issuerId}/customers/{customerReference}/accounts

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

`GET` /issuers/{issuerId}/accounts/{accountReference}/contract

`GET` /issuers/{issuerId}/card-contracts/

`GET` /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract

`GET` /issuers/{issuerId}/card-contracts/{cardContractReference}/contract

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

`GET` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts

`GET` /issuers/{issuerId}/contracts/{contractReference}

`GET` /issuers/{issuerId}/contracts/{contractReference}/card-contracts

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts

`GET` /issuers/{issuerId}/customers/{customerReference}/card-contracts

`GET` /issuers/{issuerId}/corporate-contracts/{contractReference}

`GET` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

`POST` /issuers/{issuerId}/contracts/create-consumer-contract

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

`POST` /issuers/{issuerId}/contracts/search

`POST` /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

`GET` /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

`GET` /issuers/{issuerId}/customers/{customerReference}/contracts

`GET` /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

`GET` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

`POST` /search-corporate-contracts

`POST` /issuers/{issuerId}/cards/pin-state

`POST` /issuers/{issuerId}/cards/{cardReference}/reset-pin-try-counter

`POST` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reset-pin-try-counter

`POST` /issuers/{issuerId}/companies/{customerReference}/contacts

`POST` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts

`PUT` /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}

`PUT` /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/contacts/{contactReference}

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases/{businessCaseId}

`PUT` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

`DELETE` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}

`PUT` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

`DELETE` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases/{businessCaseId}

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}

`PUT` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

`DELETE` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

`GET` /issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/{authorizationRestrictionReference}/authorization-restriction-overrides/{authorizationRestrictionOverrideReference}

`GET` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}

`PUT` /issuers/{issuerId}/accounts/{accountReference}/velocity-limits/{velocityLimitReference}/velocity-limit-overrides/{velocityLimitOverrideReference}