Release Notes: REST API V2 - 2.12.0

Read more about Release Notes: REST API V2 - 2.12.0

REST API V2 - 2.12.0

Version 2.11.2 to 2.12.0

What's New

`PATCH` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}

Update future changes of the account by external reference (beta)

Update future changes of the account by future change reference

`PATCH` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}

Update future changes of the account (beta)

Update future changes of the account by future change reference

What's Changed

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

Response:

Changed property data (object AccountBalance)
- Added property activeCreditLimit (object)

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

Response:

Changed property data (object CreditLimit)
- Added property startDate (string)

`DELETE` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}

Response:

Changed property data (object DeleteTemporaryCreditLimitResponse)
- Added property accountIdentifier (object)
- Added property root (boolean)
- Added property relatedTemporaryCreditLimits (array)

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

Response:

Changed property data (object AccountBalance)
- Added property activeCreditLimit (object)

`GET` /issuers/{issuerId}/accounts/{accountReference}/credit-limit

Response:

Changed property data (object CreditLimit)
- Added property startDate (string)

`DELETE` /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}

Response:

Changed property data (object DeleteTemporaryCreditLimitResponse)
- Added property accountIdentifier (object)
- Added property root (boolean)
- Added property relatedTemporaryCreditLimits (array)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits

Response:

Changed property data (object CreateTemporaryCreditLimitResponse)
- Added property accountIdentifier (object)
- Added property root (boolean)
- Added property relatedTemporaryCreditLimits (array)

`POST` /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits

Response:

Changed property data (object CreateTemporaryCreditLimitResponse)
- Added property accountIdentifier (object)
- Added property root (boolean)
- Added property relatedTemporaryCreditLimits (array)

`POST` /issuers/{issuerId}/cards/{cardReference}/create-emergency-card

Response:

Changed property data (object CreateEmergencyCardResponse)
- New required properties:
  - embossingName

`POST` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card

Response:

Changed property data (object CreateEmergencyCardResponse)
- New required properties:
  - embossingName

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

Parameters:

Changed: embed in query

Response:

Changed property data (object Operation)
- Added property destinationId (string)
- Added property lodgingInformation (object)
- Added property carRentalInformation (object)
- Added property airItineraryInformation (object)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object Operation)
- Added property destinationId (string)
- Added property lodgingInformation (object)
- Added property carRentalInformation (object)
- Added property airItineraryInformation (object)

`POST` /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

Request body :

Added property feeReimbursementAtCardContractClosingForChangedContract (boolean)
Deleted property feeReimbursementAtCardContractClosingForNewContract (boolean)

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

Request body :

Added property feeReimbursementAtCardContractClosingForChangedContract (boolean)
Deleted property feeReimbursementAtCardContractClosingForNewContract (boolean)

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

Parameters:

Changed: embed in query

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

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

Parameters:

Changed: embed in query

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property destinationId (string)
  - Added property lodgingInformation (object)
  - Added property carRentalInformation (object)
  - Added property airItineraryInformation (object)

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend

Response:

Changed property data (object SuspendContractResponse)
- Changed property contract (object SuspendContractResponse.Contract)
  - Changed property cardContracts (array)
    - Changed items (object SuspendContractResponse.CardContract)
      - Added property blockingRenewalReasonCode (string)
      - Added property blockingReplacementReasonCode (string)

`POST` /issuers/{issuerId}/contracts/{contractReference}/suspend

Response:

Changed property data (object SuspendContractResponse)
- Changed property contract (object SuspendContractResponse.Contract)
  - Changed property cardContracts (array)
    - Changed items (object SuspendContractResponse.CardContract)
      - Added property blockingRenewalReasonCode (string)
      - Added property blockingReplacementReasonCode (string)

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

Parameters:

Added: embed in query

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

Parameters:

Added: embed in query

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

Release Notes: REST API V2 - 2.11.2

Read more about Release Notes: REST API V2 - 2.11.2

REST API V2 - 2.11.2

Version 2.11.1 to 2.11.2

What's New

No new API.

What's Changed

`POST` /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

Request body (required -> optional)

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

Request body (required -> optional)

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

Release Notes: REST API V2 – 2.11.1

Read more about Release Notes: REST API V2 – 2.11.1

REST API V2 – 2.11.1

Version 2.11.0 to 2.11.1

What's New

`POST` /issuers/{issuerId}/contract/{contractReference}/refund-fee-on-demand

Refund fee by contract reference (beta)

The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand

Refund fee by issuer contract external reference (beta)

The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

`POST` /issuers/{issuerId}/corporate-contracts/{contractReference}/refund-fee-on-demand

Refund fee by contract reference for corporate contract (beta)

The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

`POST` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand

Refund Fee By Issuer Contract External Reference For Corporate Contract (beta)

The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

What's Changed

`POST` /issuers/{issuerId}/corporate-contracts/{contractReference}/close

Response:

Changed property data (object CloseCorporateContractResponse)
- New required properties:
  - accounts
  - corporateContract
- Added property corporateContract (object)
- Deleted property contract (object)

`POST` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/close

Response:

Changed property data (object CloseCorporateContractResponse)
- New required properties:
  - accounts
  - corporateContract
- Added property corporateContract (object)
- Deleted property contract (object)

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses

Response:

Changed property data (object ModifyContractCustomersAddressesResponse)
- Changed property customers (array)
  - Changed items (object ModifyContractCustomersAddressesResponse.Customer)
    - Changed property addresses (array)
      - Changed items (object ModifyContractCustomersAddressesResponse.Address)
        Added property invalid (boolean)

`POST` /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses

Response:

Changed property data (object ModifyContractCustomersAddressesResponse)
- Changed property customers (array)
  - Changed items (object ModifyContractCustomersAddressesResponse.Customer)
    - Changed property addresses (array)
      - Changed items (object ModifyContractCustomersAddressesResponse.Address)
        Added property invalid (boolean)

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

Release Notes: Recent Update

Read more about Release Notes: Recent Update

Recent Update

Version 2.10.1 to 2.11.0
What's New
What's Changed
What's Deleted
What's Deprecated

What's New

Cancel future changes of the account by future change reference (beta)

`POST` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel

Cancel future changes of the account by future change reference

Cancel future changes of the account by future change reference (beta)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel

Cancel future changes of the account by future change reference

Create address for a customer and subscribe to add-on (beta)

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

The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address) When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed. For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

Create address for a customer and subscribe to add-on (beta)

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

Search corporate contracts (beta)

`POST` /search-corporate-contracts

This API allows to search corporate contracts

What's Changed

Retrieve financial information by external reference

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

Response:

Changed property data (object AccountBalance)
- Added property liableBalance (object)

Create mandate by external reference

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate

Request body:

New optional properties:
- debtorBic
- debtorEmail
- debtorIban
- debtorId
- debtorName
- debtorPostalAddress
- mandateContractId
- mandateNatureType
- mandateSignCity
- mandateSignDate
- sepaCreditorId
- sepaMandateUir

Added property iban (string)
Added property bic (string)
Added property ibanOwnerName (string)

Cancel mandate by external reference

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate

Request body:

New optional properties:
- cancelMandateOnExternalSystem
- validateMandate

Added property cancellationDate (string)

Retrieve financial information

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

Response:

Changed property data (object AccountBalance)
- Added property liableBalance (object)

Create mandate

`POST` /issuers/{issuerId}/accounts/{accountReference}/create-mandate

Request body:

New optional properties:
- debtorBic
- debtorEmail
- debtorIban
- debtorId
- debtorName
- debtorPostalAddress
- mandateContractId
- mandateNatureType
- mandateSignCity
- mandateSignDate
- sepaCreditorId
- sepaMandateUir

Added property iban (string)
Added property bic (string)
Added property ibanOwnerName (string)

Cancel mandate

`POST` /issuers/{issuerId}/accounts/{accountReference}/cancel-mandate

Request body:

New optional properties:
- cancelMandateOnExternalSystem
- validateMandate

Added property cancellationDate (string)

Cancel a pending ProductChange

`POST` /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

Request body:

New content type : `*/*`

Response:

Changed property data (object CancelProductChangeResponse)
- Added property originalContract (object)
- Added property changedContract (object)

Cancel a pending ProductChange by external reference

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

Request body:

New content type : `*/*`

Response:

Changed property data (object CancelProductChangeResponse)
- Added property originalContract (object)
- Added property changedContract (object)

Retrieve future changes for the account by external reference

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{creationDate}

Response:

Changed property data (object AccountFutureUpdate)
- Added property updateStatus (string)
- Added property accountFutureUpdateIdentifier (object)
- Added property updateReason (string)
- Added property lastUpdateDate (string)
- Added property sepaCreditorId (string)
- Added property sepaMandateStatus (string)
- Added property sepaMandateUir (string)
- Added property sepaMandateUmr (string)
- Added property debtorPhoneNumber (string)
- Added property debtorEmail (string)
- Added property debtorPostalAddress (object)
- Added property mandateContractId (string)
- Added property mandateNatureType (string)
- Added property mandateSignDate (string)
- Added property mandateSignCity (string)

Create a temporary credit limit by external reference

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits

Request body:

Added property manageOverlap (boolean)

Retrieve future changes for the account

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{creationDate}

Response:

Changed property data (object AccountFutureUpdate)
- Added property updateStatus (string)
- Added property accountFutureUpdateIdentifier (object)
- Added property updateReason (string)
- Added property lastUpdateDate (string)
- Added property sepaCreditorId (string)
- Added property sepaMandateStatus (string)
- Added property sepaMandateUir (string)
- Added property sepaMandateUmr (string)
- Added property debtorPhoneNumber (string)
- Added property debtorEmail (string)
- Added property debtorPostalAddress (object)
- Added property mandateContractId (string)
- Added property mandateNatureType (string)
- Added property mandateSignDate (string)
- Added property mandateSignCity (string)

Create a temporary credit limit

`POST` /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits

Request body:

Added property manageOverlap (boolean)

Retrieve account by external reference

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

Response:

Changed property data (object Account)
- Added property isChangeOfPayerAtNextCycle (boolean)

Schedule new account parameters update in future by external reference

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates

Request body:

Added property accountFutureUpdateIdentifier (object)
Added property sepaMandate (object)
Added property updateReason (string)

Response:

Changed property data (object CreateAccountFutureUpdateResponse)
- Added property accountFutureUpdateIdentifier (object)

Retrieve list of future changes of the account by external reference

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

Response:

Changed property data (array)
- Changed items (object AccountFutureUpdate)
  - Added property updateStatus (string)
  - Added property accountFutureUpdateIdentifier (object)
  - Added property updateReason (string)
  - Added property lastUpdateDate (string)
  - Added property sepaCreditorId (string)
  - Added property sepaMandateStatus (string)
  - Added property sepaMandateUir (string)
  - Added property sepaMandateUmr (string)
  - Added property debtorPhoneNumber (string)
  - Added property debtorEmail (string)
  - Added property debtorPostalAddress (object)
  - Added property mandateContractId (string)
  - Added property mandateNatureType (string)
  - Added property mandateSignDate (string)
  - Added property mandateSignCity (string)

Retrieve operation by external reference

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

Response:

Changed property data (object Operation)
- Changed property detailedFeeAmounts (array)
  - Changed items (object DetailedFeeAmount)
    - Added property includeInOtherDetailFeeAmount (boolean)

Create velocity limit override by external account reference

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

Request body:

New required properties:
- velocityLimitOverrideIdentifier

Added property velocityLimitOverrideIdentifier (object)

Retrieve account

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

Response:

Changed property data (object Account)
- Added property isChangeOfPayerAtNextCycle (boolean)

Schedule new account parameters update in future

`POST` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates

Request body:

Added property accountFutureUpdateIdentifier (object)
Added property sepaMandate (object)
Added property updateReason (string)

Response:

Changed property data (object CreateAccountFutureUpdateResponse)
- Added property accountFutureUpdateIdentifier (object)

Retrieve list of future changes of the account

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates

Response:

Changed property data (array)
- Changed items (object AccountFutureUpdate)
  - Added property updateStatus (string)
  - Added property accountFutureUpdateIdentifier (object)
  - Added property updateReason (string)
  - Added property lastUpdateDate (string)
  - Added property sepaCreditorId (string)
  - Added property sepaMandateStatus (string)
  - Added property sepaMandateUir (string)
  - Added property sepaMandateUmr (string)
  - Added property debtorPhoneNumber (string)
  - Added property debtorEmail (string)
  - Added property debtorPostalAddress (object)
  - Added property mandateContractId (string)
  - Added property mandateNatureType (string)
  - Added property mandateSignDate (string)
  - Added property mandateSignCity (string)

Retrieve operation

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

Response:

Changed property data (object Operation)
- Changed property detailedFeeAmounts (array)
  - Changed items (object DetailedFeeAmount)
    - Added property includeInOtherDetailFeeAmount (boolean)

Create velocity limit override

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

Request body:

New required properties:
- velocityLimitOverrideIdentifier

Added property velocityLimitOverrideIdentifier (object)

Retrieve contract for an account by external reference

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

List operations for an account by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

List operations for last account statement by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

List operations for next account statement by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

List operations for an account statement by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

Retrieve contract for an account

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

List operations for an account

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

List operations for last account statement

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

List operations for next account statement

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

List operations for an account statement

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

Retrieve list of company's information (beta)

`GET` /issuers/{issuerId}/companies

Parameters:

Added: streetName in query Changed: corporateName in query

Retrieve contract for a card contract by external reference

`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 isChangeOfPayerAtNextCycle (boolean)

Retrieve contract for a card contract

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve corporate employee Accounts (beta)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve corporate employee accounts by account external reference (beta)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve corporate employee Accounts by contract external reference and account external reference (beta)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve corporate employee Accounts by contract external reference (beta)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve contract by external reference

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

List accounts for contract by external reference

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve contract

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

List accounts for contract

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

List accounts for account owner by external reference

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

List accounts for account owner

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve corporate contract (beta)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateContract)
- Added property rootAccount (object)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve corporate contract by external reference (beta)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateContract)
- Added property rootAccount (object)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)

Retrieve contracts by criteria

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

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)

List contracts for contract owner by external reference

`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 isChangeOfPayerAtNextCycle (boolean)

List contracts for contract owner

`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 isChangeOfPayerAtNextCycle (boolean)

List corporate contracts for a company (beta)

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Added property rootAccount (object)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)

List corporate contracts for a company by external reference (beta)

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Added property rootAccount (object)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)

Add an entity to a Corporate contract (beta)

`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)
      - Added property ibanOwnerName (string)

Add an entity to a Corporate contract by external reference (beta)

`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)
      - Added property ibanOwnerName (string)

Create consumer contract

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

Request body:

Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
- Changed property accounts (array)
  - Changed items (object CreateConsumerContractRequest.Account)
    - New optional properties:
      - iban
    - Added property ibanOwnerName (string)
    - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
      - New optional properties:
        debtorName
- Changed property cardContracts (array)
  - Changed items (object CreateConsumerContractRequest.CardContract)
    - Changed property card (object CreateConsumerContractRequest.Card)
      - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)
      - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)
Changed property contract (object CreateConsumerContractRequest.Contract)
- Changed property accountHierarchy (object CreateConsumerContractRequest.AccountHierarchy)
  - Changed property accounts (array)
    - Changed items (object CreateConsumerContractRequest.Account)
      - New optional properties:
        iban
      - Added property ibanOwnerName (string)
      - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
        New optional properties:
        debtorName
- Changed property cardContracts (array)
  - Changed items (object CreateConsumerContractRequest.CardContract)
    - Changed property card (object CreateConsumerContractRequest.Card)
      - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)
      - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)

Add cards and accounts to a contract by external reference

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

Request body:

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Changed property card (object CreateConsumerContractRequest.Card)
    - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
    - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
- Changed property accounts (array)
  - Changed items (object CreateConsumerContractRequest.Account)
    - New optional properties:
      - iban
    - Added property ibanOwnerName (string)
    - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
      - New optional properties:
        debtorName

Add cards and accounts to a contract

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

Request body:

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Changed property card (object CreateConsumerContractRequest.Card)
    - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
    - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
- Changed property accounts (array)
  - Changed items (object CreateConsumerContractRequest.Account)
    - New optional properties:
      - iban
    - Added property ibanOwnerName (string)
    - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
      - New optional properties:
        debtorName

Add an employee and its card(s) and account(s) to a Corporate contract (beta)

`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)
      - Added property ibanOwnerName (string)

Add an employee and its card(s) and account(s) to a Corporate contract by external reference (beta)

`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)
      - Added property ibanOwnerName (string)

Create a Corporate contract (beta)

`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)
    - Added property ibanOwnerName (string)
Changed property addCorporateContractEntities (array)
- Changed items (object CreateCorporateContractRequest.AddCorporateContractEntity)
  - Changed property corporateContractEntityAccounts (array)
    - Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
      - Changed property account (object CreateCorporateContractRequest.Account)
        Added property ibanOwnerName (string)
Changed property addCorporateEmployeeCardsAndAccounts (array)
- Changed items (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
      - Changed property account (object CreateCorporateContractRequest.Account)
        Added property ibanOwnerName (string)

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

Release Notes: REST API V2 - 2.11.0

Read more about Release Notes: REST API V2 - 2.11.0

REST API V2 - 2.11.0

Version 2.10.1 to 2.11.0

What's New

`POST` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel

Cancel future changes of the account by future change reference (beta)

Cancel future changes of the account by future change reference

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel

Cancel future changes of the account by future change reference (beta)

Cancel future changes of the account by future change reference

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

Create address for a customer and subscribe to add-on (beta)

When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

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

Create address for a customer and subscribe to add-on (beta)

When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

`POST` /search-corporate-contracts

Search corporate contracts (beta)

This API allows to search corporate contracts

What's Changed

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

Response:

Changed property data (object AccountBalance)
- Added property liableBalance (object)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate

Request body:

New optional properties:
- debtorBic
- debtorEmail
- debtorIban
- debtorId
- debtorName
- debtorPostalAddress
- mandateContractId
- mandateNatureType
- mandateSignCity
- mandateSignDate
- sepaCreditorId
- sepaMandateUir
Added property iban (string)
Added property bic (string)
Added property ibanOwnerName (string)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate

Request body:

New optional properties:
- cancelMandateOnExternalSystem
- validateMandate
Added property cancellationDate (string)

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

Response:

Changed property data (object AccountBalance)
- Added property liableBalance (object)

`POST` /issuers/{issuerId}/accounts/{accountReference}/create-mandate

Request body:

New optional properties:
- debtorBic
- debtorEmail
- debtorIban
- debtorId
- debtorName
- debtorPostalAddress
- mandateContractId
- mandateNatureType
- mandateSignCity
- mandateSignDate
- sepaCreditorId
- sepaMandateUir
Added property iban (string)
Added property bic (string)
Added property ibanOwnerName (string)

`POST` /issuers/{issuerId}/accounts/{accountReference}/cancel-mandate

Request body:

New optional properties:
- cancelMandateOnExternalSystem
- validateMandate
Added property cancellationDate (string)

`POST` /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

Request body:

New content type : */*

Response:

Changed property data (object CancelProductChangeResponse)
- Added property originalContract (object)
- Added property changedContract (object)

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

Request body:

New content type : */*

Response:

Changed property data (object CancelProductChangeResponse)
- Added property originalContract (object)
- Added property changedContract (object)

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{creationDate}

Response:

Changed property data (object AccountFutureUpdate)
- Added property updateStatus (string)
- Added property accountFutureUpdateIdentifier (object)
- Added property updateReason (string)
- Added property lastUpdateDate (string)
- Added property sepaCreditorId (string)
- Added property sepaMandateStatus (string)
- Added property sepaMandateUir (string)
- Added property sepaMandateUmr (string)
- Added property debtorPhoneNumber (string)
- Added property debtorEmail (string)
- Added property debtorPostalAddress (object)
- Added property mandateContractId (string)
- Added property mandateNatureType (string)
- Added property mandateSignDate (string)
- Added property mandateSignCity (string)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits

Request body:

Added property manageOverlap (boolean)

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{creationDate}

Response:

Changed property data (object AccountFutureUpdate)
- Added property updateStatus (string)
- Added property accountFutureUpdateIdentifier (object)
- Added property updateReason (string)
- Added property lastUpdateDate (string)
- Added property sepaCreditorId (string)
- Added property sepaMandateStatus (string)
- Added property sepaMandateUir (string)
- Added property sepaMandateUmr (string)
- Added property debtorPhoneNumber (string)
- Added property debtorEmail (string)
- Added property debtorPostalAddress (object)
- Added property mandateContractId (string)
- Added property mandateNatureType (string)
- Added property mandateSignDate (string)
- Added property mandateSignCity (string)

`POST` /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits

Request body:

Added property manageOverlap (boolean)

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

Response:

Changed property data (object Account)
- Added property isChangeOfPayerAtNextCycle (boolean)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates

Request body:

Added property accountFutureUpdateIdentifier (object)
Added property sepaMandate (object)
Added property updateReason (string)

Response:

Changed property data (object CreateAccountFutureUpdateResponse)
- Added property accountFutureUpdateIdentifier (object)

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

Response:

Changed property data (array)
- Changed items (object AccountFutureUpdate)
  - Added property updateStatus (string)
  - Added property accountFutureUpdateIdentifier (object)
  - Added property updateReason (string)
  - Added property lastUpdateDate (string)
  - Added property sepaCreditorId (string)
  - Added property sepaMandateStatus (string)
  - Added property sepaMandateUir (string)
  - Added property sepaMandateUmr (string)
  - Added property debtorPhoneNumber (string)
  - Added property debtorEmail (string)
  - Added property debtorPostalAddress (object)
  - Added property mandateContractId (string)
  - Added property mandateNatureType (string)
  - Added property mandateSignDate (string)
  - Added property mandateSignCity (string)

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

Response:

Changed property data (object Operation)
- Changed property detailedFeeAmounts (array)
  - Changed items (object DetailedFeeAmount)
    - Added property includeInOtherDetailFeeAmount (boolean)

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

Request body:

New required properties:
- velocityLimitOverrideIdentifier
Added property velocityLimitOverrideIdentifier (object)

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

Response:

Changed property data (object Account)
- Added property isChangeOfPayerAtNextCycle (boolean)

`POST` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates

Request body:

Added property accountFutureUpdateIdentifier (object)
Added property sepaMandate (object)
Added property updateReason (string)

Response:

Changed property data (object CreateAccountFutureUpdateResponse)
- Added property accountFutureUpdateIdentifier (object)

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates

Response:

Changed property data (array)
- Changed items (object AccountFutureUpdate)
  - Added property updateStatus (string)
  - Added property accountFutureUpdateIdentifier (object)
  - Added property updateReason (string)
  - Added property lastUpdateDate (string)
  - Added property sepaCreditorId (string)
  - Added property sepaMandateStatus (string)
  - Added property sepaMandateUir (string)
  - Added property sepaMandateUmr (string)
  - Added property debtorPhoneNumber (string)
  - Added property debtorEmail (string)
  - Added property debtorPostalAddress (object)
  - Added property mandateContractId (string)
  - Added property mandateNatureType (string)
  - Added property mandateSignDate (string)
  - Added property mandateSignCity (string)

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

Response:

Changed property data (object Operation)
- Changed property detailedFeeAmounts (array)
  - Changed items (object DetailedFeeAmount)
    - Added property includeInOtherDetailFeeAmount (boolean)

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

Request body:

New required properties:
- velocityLimitOverrideIdentifier
Added property velocityLimitOverrideIdentifier (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 isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Changed property detailedFeeAmounts (array)
    - Changed items (object DetailedFeeAmount)
      - Added property includeInOtherDetailFeeAmount (boolean)

`GET` /issuers/{issuerId}/companies

Parameters:

Added: streetName in query
Changed: corporateName in query

`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 isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property isChangeOfPayerAtNextCycle (boolean)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateContract)
- Added property rootAccount (object)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)

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

Parameters:

Changed: embed in query

Response:

Changed property data (object CorporateContract)
- Added property rootAccount (object)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property isChangeOfPayerAtNextCycle (boolean)

`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 isChangeOfPayerAtNextCycle (boolean)

`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 isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Added property rootAccount (object)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Added property rootAccount (object)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property isChangeOfPayerAtNextCycle (boolean)

`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)
      - Added property ibanOwnerName (string)

`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)
      - Added property ibanOwnerName (string)

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

Request body:

Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
- Changed property accounts (array)
  - Changed items (object CreateConsumerContractRequest.Account)
    - New optional properties:
      - iban
    - Added property ibanOwnerName (string)
    - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
      - New optional properties:
        debtorName
- Changed property cardContracts (array)
  - Changed items (object CreateConsumerContractRequest.CardContract)
    - Changed property card (object CreateConsumerContractRequest.Card)
      - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)
      - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)
Changed property contract (object CreateConsumerContractRequest.Contract)
- Changed property accountHierarchy (object CreateConsumerContractRequest.AccountHierarchy)
  - Changed property accounts (array)
    - Changed items (object CreateConsumerContractRequest.Account)
      - New optional properties:
        
        iban
      - Added property ibanOwnerName (string)
      - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
        
        New optional properties:
        debtorName
- Changed property cardContracts (array)
  - Changed items (object CreateConsumerContractRequest.CardContract)
    - Changed property card (object CreateConsumerContractRequest.Card)
      - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)
      - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
        Added property customDeliveryAddressee (string)
        
        Added property customDeliveryAddress (object)

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

Request body:

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Changed property card (object CreateConsumerContractRequest.Card)
    - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
    - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
- Changed property accounts (array)
  - Changed items (object CreateConsumerContractRequest.Account)
    - New optional properties:
      - iban
    - Added property ibanOwnerName (string)
    - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
      - New optional properties:
        debtorName

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

Request body:

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Changed property card (object CreateConsumerContractRequest.Card)
    - Changed property cardOrder (object CreateConsumerContractRequest.CardOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
    - Changed property pinMailerOrder (object CreateConsumerContractRequest.PinMailerOrder)
      - Added property customDeliveryAddressee (string)
      - Added property customDeliveryAddress (object)
Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
- Changed property accounts (array)
  - Changed items (object CreateConsumerContractRequest.Account)
    - New optional properties:
      - iban
    - Added property ibanOwnerName (string)
    - Changed property sepaMandate (object CreateConsumerContractRequest.SepaMandate)
      - New optional properties:
        debtorName

`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)
      - Added property ibanOwnerName (string)

`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)
      - Added property ibanOwnerName (string)

`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)
    - Added property ibanOwnerName (string)
Changed property addCorporateContractEntities (array)
- Changed items (object CreateCorporateContractRequest.AddCorporateContractEntity)
  - Changed property corporateContractEntityAccounts (array)
    - Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
      - Changed property account (object CreateCorporateContractRequest.Account)
        Added property ibanOwnerName (string)
Changed property addCorporateEmployeeCardsAndAccounts (array)
- Changed items (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
      - Changed property account (object CreateCorporateContractRequest.Account)
        Added property ibanOwnerName (string)

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

Contact

Read more about Contact

Get in touch

Please get in touch if you need any assistance, our team is happy to help.

Send us a mail

Initiating Party Extranet

Read more about Initiating Party Extranet

Initiating Party Extranet

The Initiating Party Extranet is the GUI Interface for the Initiating Party to access and use the Open Banking Platform and provides the following Modules:

Master data and Subscription Management

Transaction Management and Post Processing

Refund Processing

User Management

Secure User Login

Report Management

Documents (view and download only)

Online Help

Functional Modules with partly or without GUI Access:

Directory Service Management ♦ Reconciliation / Clearing Module ♦ Audit Logs ♦ White Labelling

Administrator Portal

Read more about Administrator Portal

Administrator Portal

The Administrator Portal is the GUI Interface for Backoffice Users of the client to access and administer the Open Banking Platform. It provides the following modules:

Bank Selection Interface

Initiating Party and Subscription Management

User and Access Management

Service Provider Management

Banks can set up Providers for Initiating Parties in their environment. Those Service Providers do the technical integration for them and make it more easy to offer payment means to the customers. So (e.g. smaller) Initiating Parties can avoid the effort of integrating to the routing services systems for each payment mean by choosing a PSP as Way of Integration during the onboarding The service provider needs some configuration on the system, e.g. they have to provide a valid certificate and some mandatory data. In order to maintain the service providers per service to be offered to Initiating Parties as connection method, the Open Banking Platform provides the Service Provider Management.

Which features are provided?
The Service Provider Management enables Initiating Parties and Bank Backoffice Admins according to their access rights to maintain the following features: Service Provider data, Account data, Service Subscription Data, Technical & Security data, Setup, check, manage, deactivate existing service providers.

User Login Functionalities

As standard the Backoffice includes an access control via personified login page, the user can insert his name and valid password into the according fields and submit via the Login button. If the entered data don’t match, an error message (Authorization failed) informs him and after repetition and successful validation he is logged in the application. In case of forgotten password, additionally a link “Forgot Password” available. Using it, an according dialog starts to renew the current password.
Also as standard solution our Backoffice includes an user login with 2FA Authentication, which can be activated per acquirer bank / tenant via the configuration management. Once activated the existing username/password is used as first factor, the smartphone functions as second factor. On the smartphone an One Time Password (The user has to install an OTP generator on his smartphone, e.g. FreeOTP Authenticator). can be used to provide a temporary valid OTP, which has to be entered into the login form.

In addition the latest possible date from which the use of the OTP feature becomes mandatory for users is configurable on per acquirer / tenant: In this case an individual “Start of OTP” is stored for each user (new or already existing), who does the first login for his acquirer via 2FA. During every login now is checked, whether the individual "Start of OTP" date of the user is already exceeded and how many days remain until expiration. Before expiration, the user is able skip the OTP secret verification (via an according button on the GUI), afterwards he has to verify and register an OTP secret.

As login mechanismen to the bank systems we provide Web Single Sign On functionality (Web SSO) using credentials for authentication, which are a unique username and password: By using this functionality the first step it is checked if the user is already logged in to the authentication system. Users, who are already signed in, are marked as Single Sign On Users in the system and are granted access immediately. If not, the user is directed to the authentication system to sign in. For each session, the user must first sign into the authentication system with a unique username and password. The authentication system uses a token for the session that stays in effect until the user logs out.

After the authentication process is running, the authentication information is passed to the application, requesting verification of the user.
To login the OB Platform via Web Single Sign On (Web SSO) the banks offer special URLs. The Certificate, which is needed for the securing the Web SSO connection, can be uploaded via the Merchant and Subscription Management Module.

Certificate Management

Our Certificate Management provides a central management for certificates and is operated from the Backoffice GUI. As a consequence of PSD2 this functionality allows to manage hundreds of certificates and to automatically update related keystores in all associated Routing Service Instances during runtime: Certificates can be refreshed automatically during application runtime of the Routing service.

The Certificate Management allows creating Qualified Website Authentication Certificates (commonly known as TLS certificates) and Qualified Electronic Seal, certificate signing request (CSR). Whereas the key pairs, consisting of a private and public key, for QWAC CSRs are generated by the module itself; keys for QSEAL CSRs are derived from HSM Boxes using the restcrypto-server application.

Once the official signing process of QWAC and QSEAL CSRs is completed by an external certification authority (CA), the resulted certificates can be uploaded to the Certificate Management Module.

At last a functionality within the module allows the user to send the certificates (as for QWACs the private keys as well) wrapped in a keystore to the Routing Service Instances at runtime.

If the same certifiacte (fingerprint) is stored on merchant and subscription level, the certificate is only stored once. It will only be deleted, when the certifcate is deleted on both levels on Backoffice side.

I is possible to Upload Certificates for the API authentication in the BO on merchant level additionally to the ones on subscription level. This is allowing to use the same certificate for all subscriptions.

Transactions Processing/ Refund Processing: Overview of all IP running on the system

Initiating Party Ticketing/Support

Document Management

Dynamic Creditor Account Lookup (DCAL)

We provide a Dynamic Creditor Account Lookup Service , which can be switched on or off for each of the tenants’ Initiating Party (by the tenant’s Backoffice Admin). If the DCAL is activated, up to ten additional creditor accounts can be set up. This service will only be used for Initiating Party without Sub Ids.
In case, the DCAL service is switched off, but DCAL entries already exist, those entries will not be deleted. When DCAL is switched back on, the data are available again. Clients, who have access to the Backoffice as Admin User can select the DCAL option itself in the Tenant GUI and on the Initiating Party GUI , in the PIS service configuration.

Via the DCAL screen the on/off switch can be managed very easily and on the DCAL table creditor accounts can be created, updated and deleted.

Backoffice

Read more about Backoffice

Backoffice

The Open Banking Platform consists of several components, that you might use depending on the product - the Back Office is one major component, allowing to onboard and manage your clients, view transactions and create refunds. Here you'll find an overview of modules, which we offer and might be of interest.

The Administrator Portal is the GUI Interface for Backoffice Users of the client to access and administer the Open Banking Platform. It provides the following modules:

Initiating Party and Subscription Management ♦ User and Access Management ♦ Initiation Service ♦ User Login Functionalities ♦ Certificate Management ♦ Transactions Processing/ Refund Processing ♦ Initiating Party Ticketing/Support ♦ Document Management ♦ Dynamic Creditor Account Lookup

The Initiating Party Extranet is the GUI Interface for the Initiating Party to access and use the Open Banking Platform and provides the following Modules: Master data and Subscription Management ♦ Transaction Management and Post Processing ♦ Refund Processing ♦ User Management ♦ Secure User Login ♦ Report Management ♦ Documents (view and download only) ♦ Online Help

Functional Modules with partly or without GUI Access:

Directory Service Management ♦ Reconciliation / Clearing Module ♦ Audit Logs ♦ White Labelling

Release Notes: REST API V2 - 2.10.1

Read more about Release Notes: REST API V2 - 2.10.1

REST API V2 - 2.10.1

Version 2.10.0 to 2.10.1
What's New
What's Changed
What's Deleted
What's Deprecated

What's New

Post a Bonus operation for an account (beta)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-bonus-operation

The API is used to post manually a Bonus operation to an account. A Bonus operation is used to reward or adjust a given account (in credit or in debit, e.g. in case of too high, too low or missing reward). As an input it must be provided

the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
the related Bonus program, defined for the issuer and the account
the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
it is possible to post credit and debit bonus operation If the Bonus operation is related to an existing initial operation, this latter can be provided. As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.

Reverse a Bonus operation for an account (beta)

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-bonus-operation

The API is used to fully reverse a Bonus operation previously posted on an account. As an input it must be provided

the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
the Bonus operation to be reversed
the information related to the reversal operation (reference, date, service poster)

Post a Bonus operation for an account (beta)

`POST` /issuers/{issuerId}/accounts/{accountReference}/post-bonus-operation

the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation has to be posted
the related Bonus program, defined for the issuer and the account
the Bonus operation itself, uniquely identified by its external reference, date and service poster, its amount in currency (monetary) or loyalty point kind (non monetary) Note:
for monetary bonus the provided currency must be the same than the posting account, for non monetary bonus the provided loyalty point unit must be allowed by the Bonus program
it is possible to post credit and debit bonus operation If the Bonus operation is related to an existing initial operation, this latter can be provided. As a result the Bonus operation is posted to the account. Monetary bonus has an immediate impact on the account balance.

Reverse a Bonus operation for an account (beta)

`POST` /issuers/{issuerId}/accounts/{accountReference}/reverse-bonus-operation

The API is used to fully reverse a Bonus operation previously posted on an account. As an input it must be provided

the account, identified either by its account reference generated by WL or its issuer external account reference, on which the bonus operation was previously posted
the Bonus operation to be reversed
the information related to the reversal operation (reference, date, service poster)

Create a new WL Message subscription

`POST` /issuers/{issuerId}/subscriptions

Search for subscriptions (with non-pci search terms)

`GET` /issuers/{issuerId}/subscriptions/search

Retrieve subscription by reference

`GET` /issuers/{issuerId}/subscriptions/{subscriptionReference}

Modify subscription by reference

`PUT` /issuers/{issuerId}/subscriptions/{subscriptionReference}

Delete subscription by reference

`DELETE` /issuers/{issuerId}/subscriptions/{subscriptionReference}

Retrieve services by subscription reference

`GET` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services

Create new service subscription

`POST` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services

Retrieve services for a subscription

`GET` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}

Modify subscription service by reference

`PUT` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}

Delete subscription service by reference

`DELETE` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}

Retrieve subscritpion events by subscription service reference

`GET` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events

Create new event subscription

`POST` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events

Retrieve event for a subscription service

`GET` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}

Modify subscription event by reference

`PUT` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}

Delete subscription event by reference

`DELETE` /issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}/events/{subscriptionEventReference}

What's Changed

Retrieve card by external reference

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

Parameters:

Changed: embed in query

Response:

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

Retrieve card order by external reference

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

Response:

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

Retrieve card

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

Parameters:

Changed: embed in query

Response:

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

Retrieve card order

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

Response:

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

Request credit instalment model simulation

`POST` /issuers/{issuerId}/credit-instalments/simulate

Response:

Changed property data (object CreditInstalmentSimulationResponse)
- New required properties:
  - simulationDetails
- Changed property simulationDetails (array)
  - Changed items (object CreditInstalmentSimulationResponseSimulationDetails)
    - New required properties:
      - instalmentModelReference
      - instalmentTerm
      - interestRate
      - monthlyRepaymentAmount
      - totalInterestAmount

Retrieve customer address by customer external reference and address external reference

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

Response:

Changed property data (object Address)
- Added property temporary (boolean)

Retrieve customer address by customer external reference

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

Response:

Changed property data (object Address)
- Added property temporary (boolean)

Retrieve customer address by address external reference

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

Response:

Changed property data (object Address)
- Added property temporary (boolean)

Retrieve customer address

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

Response:

Changed property data (object Address)
- Added property temporary (boolean)

Retrieve account by external reference

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

Response:

Changed property data (object Account)
- Added property hierarchyBonusProgramReferences (array)
- Added property openCycleInformation (object)

Retrieve account guarantor for an account by external reference

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve account owner for an account by external reference

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve operation by external reference

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

Response:

Changed property data (object Operation)
- Added property loyaltyPoint (object)
- Added property rewardedOperationIdentifier (object)

Create velocity limit override by external account reference

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

Request body:

New optional properties:
- velocityLimitOverrideIdentifier

Deleted property velocityLimitOverrideIdentifier (object)

Retrieve account

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

Response:

Changed property data (object Account)
- Added property hierarchyBonusProgramReferences (array)
- Added property openCycleInformation (object)

Retrieve account guarantor for an account

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve account owner for an account

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve operation

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

Response:

Changed property data (object Operation)
- Added property loyaltyPoint (object)
- Added property rewardedOperationIdentifier (object)

Create velocity limit override

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

Request body:

New optional properties:
- velocityLimitOverrideIdentifier

Deleted property velocityLimitOverrideIdentifier (object)

Retrieve company's information (beta)

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

Response:

Changed property data (object Company)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve company information by external reference (beta)

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

Response:

Changed property data (object Company)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Create address for a company customer (beta)

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

Request body:

Added property endDate (string)
Added property temporary (boolean)

Retrieve company's Address information list (beta)

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

Response:

Changed property data (array)
- Changed items (object Address)
  - Added property temporary (boolean)

Retrieve company's address information by address ref (beta)

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

Response:

Changed property data (object Company)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve company's address information by address external reference (beta)

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

Response:

Changed property data (object Company)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Create address for a company by external reference (beta)

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

Request body:

Added property endDate (string)
Added property temporary (boolean)

Retrieve company's Address information list by external reference (beta)

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

Response:

Changed property data (array)
- Changed items (object Address)
  - Added property temporary (boolean)

Retrieve address information by company external reference (beta)

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

Response:

Changed property data (object Company)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve address information by company external reference and address external reference (beta)

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

Response:

Changed property data (object Company)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve card contract by external reference

`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 orders (array)

Retrieve cardholder for a card contract by external reference

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

List cards for card contract by external reference

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

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property orders (array)

Retrieve card contract

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

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property orders (array)

Retrieve cardholder for a card contract

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

List cards for card contract

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

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property orders (array)

Retrieve card contract for a card by external reference

`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 orders (array)

List orders for a card by external reference

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

Response:

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

Retrieve card by cardNumber and sequenceNumber and expiryDate

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

Parameters:

Changed: embed in query

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property orders (array)

Retrieve card contract for a card

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

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property orders (array)

List orders for a card

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

Response:

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

Retrieve contract owner for a contract by external reference

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Retrieve contract owner for a contract

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Create credit instalment contract

`POST` /issuers/{issuerId}/credit-instalments/

Request body:

New required properties:
- payingAccountIdentifier
- receivingAccountIdentifier

New optional properties:
- instalmentModelReference

Retrieve customer by external reference

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Create address for a customer by external reference

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

Request body:

Added property endDate (string)
Added property temporary (boolean)

List addresses for a customer by external reference

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

Response:

Changed property data (array)
- Changed items (object Address)
  - Added property temporary (boolean)

Retrieve customer

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

Response:

Changed property data (object Customer)
- Changed property addresses (array)
  - Changed items (object Address)
    - Added property temporary (boolean)

Create address for a customer

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

Request body:

Added property endDate (string)
Added property temporary (boolean)

List addresses for a customer

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

Response:

Changed property data (array)
- Changed items (object Address)
  - Added property temporary (boolean)

Retrieve contract for an account by external reference

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

Response:

Changed property data (object Contract)
- Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
- Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property hierarchyBonusProgramReferences (array)
    - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)

List operations for an account by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

List operations for last account statement by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

List operations for next account statement by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

List operations for an account statement by external reference

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

Retrieve contract for an account

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

Response:

Changed property data (object Contract)
- Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
- Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property hierarchyBonusProgramReferences (array)
    - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)

List operations for an account

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

List operations for last account statement

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

List operations for next account statement

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

List operations for an account statement

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property loyaltyPoint (object)
  - Added property rewardedOperationIdentifier (object)

Retrieve list of company's information (beta)

`GET` /issuers/{issuerId}/companies

Response:

Changed property data (array)
- Changed items (object Company)
  - Changed property addresses (array)
    - Changed items (object Address)
      - Added property temporary (boolean)

Retrieve contract for a card contract by external reference

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

Response:

Changed property data (object Contract)
- Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
- Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property hierarchyBonusProgramReferences (array)
    - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)

Retrieve contract for a card contract

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

Response:

Changed property data (object Contract)
- Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
- Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property hierarchyBonusProgramReferences (array)
    - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)

Retrieve corporate employee Accounts (beta)

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

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)

Retrieve corporate employee accounts by account external reference (beta)

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

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)

Retrieve corporate employee Accounts by contract external reference and account external reference (beta)

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

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)

Retrieve corporate employee Accounts by contract external reference (beta)

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

Response:

Changed property data (object CorporateEmployeeAccountResponse)
- Changed property account (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)

Update contract by external reference

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

Request body:

Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)

Retrieve contract by external reference

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

Response:

Changed property data (object Contract)
- Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
- Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property hierarchyBonusProgramReferences (array)
    - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)

List accounts for contract by external reference

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)

List card contracts for contract by external reference

`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 orders (array)

Update addresses of all customers linked to the contract by external reference

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses

Request body:

Changed property addresses (array)
- Changed items (object ModifyContractCustomersAddressesRequest.Address)
  - Added property invalid (boolean)

Update contract

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

Request body:

Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)

Retrieve contract

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

Response:

Changed property data (object Contract)
- Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
- Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
- Changed property accounts (array)
  - Changed items (object Account)
    - Added property hierarchyBonusProgramReferences (array)
    - Added property openCycleInformation (object)
- Changed property cardContracts (array)
  - Changed items (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property orders (array)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)

List accounts for contract

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)

List card contracts for contract

`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 orders (array)

Update addresses of all customers linked to the contract

`POST` /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses

Request body:

Changed property addresses (array)
- Changed items (object ModifyContractCustomersAddressesRequest.Address)
  - Added property invalid (boolean)

Retrieve list of customer's information

`GET` /issuers/{issuerId}/customers

Response:

Changed property data (array)
- Changed items (object Customer)
  - Changed property addresses (array)
    - Changed items (object Address)
      - Added property temporary (boolean)

List accounts for account owner by external reference

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)

List card contracts for cardholder by external reference

`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 orders (array)

List accounts for account owner

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Added property hierarchyBonusProgramReferences (array)
  - Added property openCycleInformation (object)

List card contracts for cardholder

`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 orders (array)

Retrieve corporate contract (beta)

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

Response:

Changed property data (object CorporateContract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)
- Changed property contractCompanies (array)
  - Changed items (object Company)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property hierarchyBonusProgramReferences (array)
      - Added property openCycleInformation (object)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property hierarchyBonusProgramReferences (array)
      - Added property openCycleInformation (object)
    - Changed property cardContracts (array)
      - Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property orders (array)

Retrieve corporate contract by external reference (beta)

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

Response:

Changed property data (object CorporateContract)
- Changed property contractCustomers (array)
  - Changed items (object Customer)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)
- Changed property contractCompanies (array)
  - Changed items (object Company)
    - Changed property addresses (array)
      - Changed items (object Address)
        Added property temporary (boolean)
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Added property hierarchyBonusProgramReferences (array)
      - Added property openCycleInformation (object)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Added property hierarchyBonusProgramReferences (array)
      - Added property openCycleInformation (object)
    - Changed property cardContracts (array)
      - Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property orders (array)

Retrieve contracts by criteria

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

Parameters:

Changed: embed in query

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
  - Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property hierarchyBonusProgramReferences (array)
      - Added property openCycleInformation (object)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property orders (array)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Changed property addresses (array)
        Changed items (object Address)
        Added property temporary (boolean)

List contracts for contract owner by external reference

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

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
  - Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property hierarchyBonusProgramReferences (array)
      - Added property openCycleInformation (object)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property orders (array)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Changed property addresses (array)
        Changed items (object Address)
        Added property temporary (boolean)

List contracts for contract owner

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

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
  - Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Added property hierarchyBonusProgramReferences (array)
      - Added property openCycleInformation (object)
  - Changed property cardContracts (array)
    - Changed items (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property orders (array)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Changed property addresses (array)
        Changed items (object Address)
        Added property temporary (boolean)

List corporate contracts for a company (beta)

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Changed property addresses (array)
        Changed items (object Address)
        Added property temporary (boolean)
  - Changed property contractCompanies (array)
    - Changed items (object Company)
      - Changed property addresses (array)
        Changed items (object Address)
        Added property temporary (boolean)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property hierarchyBonusProgramReferences (array)
        
        Added property openCycleInformation (object)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property hierarchyBonusProgramReferences (array)
        
        Added property openCycleInformation (object)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property orders (array)

List corporate contracts for a company by external reference (beta)

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property contractCustomers (array)
    - Changed items (object Customer)
      - Changed property addresses (array)
        Changed items (object Address)
        Added property temporary (boolean)
  - Changed property contractCompanies (array)
    - Changed items (object Company)
      - Changed property addresses (array)
        Changed items (object Address)
        Added property temporary (boolean)
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Added property hierarchyBonusProgramReferences (array)
        
        Added property openCycleInformation (object)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Added property hierarchyBonusProgramReferences (array)
        
        Added property openCycleInformation (object)
      - Changed property cardContracts (array)
        Changed items (object CardContract)
        Changed property cards (array)
        Changed items (object Card)
        Added property orders (array)

Create consumer contract

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

Request body:

Changed property contract (object CreateConsumerContractRequest.Contract)
- Changed property numberOfFreeCardsMembershipFee (integer-int64 -> integer-int32)
- Changed property numberOfFreeCardsAccountSetupFee (integer-int64 -> integer-int32)

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

Subscribe to

Release Notes: REST API V2 - 2.12.0

REST API V2 - 2.12.0

Version 2.11.2 to 2.12.0

What's New

PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}

PATCH /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}

What's Changed

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

Response:

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

Response:

DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}

Response:

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

Response:

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

Response:

DELETE /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}

Response:

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits

Response:

POST /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits

Response:

POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card

Response:

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card

Response:

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

Parameters:

Response:

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

Parameters:

Response:

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

Request body :

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

Request body :

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

Parameters:

Response:

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

Response:

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

Response:

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

Response:

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

Parameters:

Response:

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

Response:

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

Response:

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

Response:

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend

Response:

POST /issuers/{issuerId}/contracts/{contractReference}/suspend

Response:

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

Parameters:

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

Parameters:

What's Deleted

What's Deprecated

Release Notes: REST API V2 - 2.11.2

REST API V2 - 2.11.2

Version 2.11.1 to 2.11.2

What's New

What's Changed

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

Request body (required -> optional)

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

Request body (required -> optional)

What's Deleted

What's Deprecated

Release Notes: REST API V2 – 2.11.1

REST API V2 – 2.11.1

Version 2.11.0 to 2.11.1

What's New

`PATCH` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}

`PATCH` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}

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

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

`DELETE` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}

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

`GET` /issuers/{issuerId}/accounts/{accountReference}/credit-limit

`DELETE` /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits

`POST` /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits

`POST` /issuers/{issuerId}/cards/{cardReference}/create-emergency-card

`POST` /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card

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

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

`POST` /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

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

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

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

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

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

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

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

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

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend

`POST` /issuers/{issuerId}/contracts/{contractReference}/suspend

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

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

`POST` /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

`POST` /issuers/{issuerId}/contract/{contractReference}/refund-fee-on-demand

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand

`POST` /issuers/{issuerId}/corporate-contracts/{contractReference}/refund-fee-on-demand

`POST` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/refund-fee-on-demand

`POST` /issuers/{issuerId}/corporate-contracts/{contractReference}/close

`POST` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/close

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses

`POST` /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses

`POST` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel

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

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

`POST` /search-corporate-contracts

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

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/create-mandate

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-mandate

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

`POST` /issuers/{issuerId}/accounts/{accountReference}/create-mandate

`POST` /issuers/{issuerId}/accounts/{accountReference}/cancel-mandate

`POST` /issuers/{issuerId}/contracts/{contractReference}/cancel-product-change

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-product-change

`GET` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{creationDate}

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{creationDate}

`POST` /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits

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

`POST` /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates

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

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

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

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

`POST` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates

`GET` /issuers/{issuerId}/accounts/{accountReference}/account-future-updates