Version 2.29.1 to 2.30.1

What's New

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

Retrieve letter for the card (beta)

Retrieve letter for the card by card reference and letter reference

DELETE /issuers/{issuerId}/cards/{cardReference}/letters/{letterId}

Delete a letter for a card (beta)

Delete a letter for a card

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

Retrieve letter for a card by external reference (beta)

Retrieve letter for the card by card reference and letter reference

DELETE /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}

Delete a letter for a card by external reference (beta)

Delete a letter for a card

POST /issuers/{issuerId}/cards/{cardReference}/letters/{letterId}/validate

Validate a letter for a card (beta)

Validate a letter for a card

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/letters/{letterId}/validate

Validate a letter for a card by external reference (beta)

Validate a letter for a card

POST /issuers/{issuerId}/cards/{cardReference}/generate-letter

Generate letter for a card (beta)

The API allows to generate a letter for a card. The main input fields requested by the API are: • The issuer ID • The card for which the letter generation is requested: It can be provided by using the card reference or the issuer external card reference • The letter template reference which is used to generate the letter

During letter generation following controls will be performed:

• If the template parameter is defined with a validator, the validator will be applied on the provided value.
• If the template parameter is a list (display type = list), the system will check that the provided value belongs to the list.
• If the template parameter is not modifiable, the system will check that the provided value is equal to dynamically computed value.
• If the value is defined as invalid, the system will check that the provided value is not equal to dynamically computed value.
• If the template is configured with a validator (xsd file for instance), the validator will be applied on the generated letter.
• If the value is not provided in input, the value dynamically computed by the system will be used.

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/generate-letter

Generate letter for a card by external reference (beta)

The API allows to generate a letter for a card. The main input fields requested by the API are: • The issuer ID • The card for which the letter generation is requested: It can be provided by using the card reference or the issuer external card reference • The letter template reference which is used to generate the letter

During letter generation following controls will be performed:

• If the template parameter is defined with a validator, the validator will be applied on the provided value.
• If the template parameter is a list (display type = list), the system will check that the provided value belongs to the list.
• If the template parameter is not modifiable, the system will check that the provided value is equal to dynamically computed value.
• If the value is defined as invalid, the system will check that the provided value is not equal to dynamically computed value.
• If the template is configured with a validator (xsd file for instance), the validator will be applied on the generated letter.
• If the value is not provided in input, the value dynamically computed by the system will be used.

GET /issuers/{issuerId}/cards/{cardReference}/prefilled-letter-templates/{letterTemplateReference}

Get parameters for the defined letter templates (beta)

Get parameters for the defined letter templates by card reference

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/prefilled-letter-templates/{letterTemplateReference}

Get parameters for the defined letter templates by external reference (beta)

Get parameters for the defined letter templates by card reference

GET /issuers/{issuerId}/cards/letter-templates

List of available letter templates for cards (beta)

List of available letter templates for cards

GET /issuers/{issuerId}/cards/letter-templates/{letterTemplateReference}

Retrieve a specific letter template (beta)

Retrieve a specific letter template

POST /issuers/{issuerId}/cards/{cardReference}/advise-product-extension

Advice a product extension for a card (beta)

This API is used to get the product extension for a card replacement depending on the configured algorithm. The main input fields are: • The issuer ID • The card for which the advice is requested: It can be provided by using the card reference or the issuer card external reference. The API returns the product extension advised for the card replacement and also the current product extension of the card.

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/advise-product-extension

Advice a product extension for a card by external reference (beta)

This API is used to get the product extension for a card replacement depending on the configured algorithm. The main input fields are: • The issuer ID • The card for which the advice is requested: It can be provided by using the card reference or the issuer card external reference. The API returns the product extension advised for the card replacement and also the current product extension of the card.

POST /issuers/{issuerId}/contracts/advise-product-extension

Advice a product extension (beta)

This API is used to get the product extension for a card creation depending on the configured algorithm. It can be used for the first card or additional card. The main input fields are:

• The issuer ID
• The issuer product external reference for which the advice is requested. The API returns the product extension advised for the card creation.

GET /issuers/{issuerId}/products/external-products/{issuerProductExternalReference}/product-extension-balancing

Retrieve the product extensions' load balancing by issuer product external reference (beta)

The API allows the parameters of the product extensions' load balancing to be retrieved. The parameters of the load balancing are used when a new card is requested. The main input fields are:

• The issuer ID
• The issuer product external reference for which the detail of the product extensions' load balancing is requested.

PATCH /issuers/{issuerId}/products/external-products/{issuerProductExternalReference}/product-extension-balancing

Override the product extensions' load balancing by issuer product external reference (beta)

The API allows a list of pre-defined parameters for a product extensions' load balancing to be overridden. The parameters of the load balancing are used when a new card is requested. The main input fields are:

• The issuer ID
• The issuer product external reference for which the changes are required
• The parameters (profiles or thresholds of a product) to be overridden

The parameters of the load balancing can be retrieved using the Retrieve the product extensions' load balancing API. The overridden parameters should be consistent with the initial product configuration defined in the system (e.g., the profiles to be updated must exist in the system to be found).

GET /issuers/{issuerId}/card-products/{cardTemplateReference}/card-producer-balancing

Retrieve the card producers' load balancing (beta)

The API allows the parameters of the load balancing between card producers to be retrieved. The main input field is:

• The issuer ID
• The card template reference for which the detail of the card producers' load balancing is requested.

PATCH /issuers/{issuerId}/card-products/{cardTemplateReference}/card-producer-balancing

Override the card producers' load balancing (beta)

The API allows for the replacement of the load balancing parameters between card producers. The main input fields are:

• The issuer ID
• The card template reference for which the changes are requested
• The parameters to be overridden

The overridden parameters of the card producers' load balancing can be retrieved using the Retrieve the card producers' load balancing API.

What's Changed

POST /search-transactions

Request body :

Added property cardIdentifier (object)

Added property accountIdentifier (object)

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

Request body :

Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)

Changed property corporateContractEntityAccounts (array)

Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)

Changed property account (object CreateCorporateContractRequest.Account)

Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)

Changed property debtorPostalAddress (string -> object)

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

Request body :

Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)

Changed property corporateContractEntityAccounts (array)

Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)

Changed property account (object CreateCorporateContractRequest.Account)

Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)

Changed property debtorPostalAddress (string -> object)

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

Request body :

Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)

Changed property corporateEmployeeAccounts (array)

Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)

Changed property account (object CreateCorporateContractRequest.Account)

Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)

Changed property debtorPostalAddress (string -> object)

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

Request body :

Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)

Changed property corporateEmployeeAccounts (array)

Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)

Changed property account (object CreateCorporateContractRequest.Account)

Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)

Changed property debtorPostalAddress (string -> object)

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

Request body :

Changed property addCorporateVcaServiceCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateVcaServiceCardsAndAccounts)

Changed property corporateEmployeeAccounts (array)

Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)

Changed property account (object CreateCorporateContractRequest.Account)

Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)

Changed property debtorPostalAddress (string -> object)

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

Request body :

Changed property addCorporateVcaServiceCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateVcaServiceCardsAndAccounts)

Changed property corporateEmployeeAccounts (array)

Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)

Changed property account (object CreateCorporateContractRequest.Account)

Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)

Changed property debtorPostalAddress (string -> object)

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

Request body :

Changed property corporateContract (object CreateCorporateContractRequest.Contract)

Changed property corporateContractRootEntity (object CreateCorporateContractRequest.CorporateContractRootEntity)

Changed property rootAccount (object CreateCorporateContractRequest.Account)

Changed property sepaMandate (object CreateCorporateContractRequest.SepaMandate)

Changed property debtorPostalAddress (string -> object)

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

Response:

Changed property data (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

GET /issuers/{issuerId}/credit-transfers/{endToEndId}

Parameters:

Added: embed in query

Response:

Changed property data (object CreditTransfer)

Added property statusHistory (array)

GET /issuers/{issuerId}/direct-debits/{endToEndId}

Parameters:

Added: embed in query

Response:

Changed property data (object DirectDebit)

Added property statusHistory (array)

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

Response:

Changed property data (array)

Changed items (object CreditTransfer)

Added property statusHistory (array)

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

Response:

Changed property data (array)

Changed items (object DirectDebit)

Added property statusHistory (array)

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

Response:

Changed property data (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/inquire-operation

Response:

Changed property data (object Operation)

Added property origin (string)

Added property username (string)

GET /issuers/{issuerId}/accounts/{accountReference}/credit-transfers

Response:

Changed property data (array)

Changed items (object CreditTransfer)

Added property statusHistory (array)

GET /issuers/{issuerId}/accounts/{accountReference}/direct-debits

Response:

Changed property data (array)

Changed items (object DirectDebit)

Added property statusHistory (array)

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

Response:

Changed property data (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Statement)

Changed property reprintHistory (array)

Changed items (object ReprintHistory)

Added property origin (string)

Added property username (string)

POST /issuers/{issuerId}/accounts/{accountReference}/inquire-operation

Response:

Changed property data (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

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

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

POST /search-operations

Response:

Changed property data (array)

Changed items (object Operation)

Added property origin (string)

Added property username (string)

What's Deprecated

POST /issuers/{issuerId}/contracts/brand-advice

Get a brand selection advice (beta)

This API allows getting an advice on which brand to select for a card creation (either first card along new contract, additional card or replacement card). This is applicable for products on which brand selection is configured. The API returns the product extension for the advised card brand

GET /issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}

Retrieve brand advice algorithm configuration by issuer product external reference (beta)

The API allows the brand advice configuration to be retrieved. The main input fields are:

• The issuer ID
• The issuer product external reference for which the configuration details are requested.

PATCH /issuers/{issuerId}/contracts/brand-advice-config/{issuerProductExternalReference}

Update brand advice algorithm configuration by issuer product external reference (beta)

The API allows a list of pre-defined parameters (attributes) of a brand advice configuration to be updated. The main input fields are:

• The issuer ID
• The issuer product external reference for which configuration updates are required.
• Parameters to be updated

The brand advice configuration parameters can be retrieved using the Retrieve brand advice detail API. The updated parameters should be consistent with the initial product configuration defined in the system (e.g., the profiles to be updated must exist in the system to be found).