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

 

API Reference
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.

Enable "on this page" menu on doc section
On

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

 

API Reference

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.

Enable "on this page" menu on doc section
On

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

 

API Reference
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.

Enable "on this page" menu on doc section
On

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

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.

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.

Enable "on this page" menu on doc section
On

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

 

API Reference
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)

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.

 

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

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

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.

 

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.

Enable "on this page" menu on doc section
On
Subscribe to