Version 2.7.1 to 2.8.0

What's New

---

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

Retrieve turnover information for an account

The API is used to get the turnover information for an account

GET /issuers/{issuerId}/accounts/{accountReference}/turnover-information

Retrieve turnover information for an account

The API is used to get the turnover information for an account

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

Retrieve company's information

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

Update company

The "update company" API allows the user to update the attributes of a customer. To identify the customer, it is needed to provide:

• The issuer ID
• The customer reference (internal or external) for which updates are required

The customer reference can be retrieved by using the "list customers" API. All the attributes must be given in input even if they remain unchanged. For that, It can be needed to use the "retrieve customer" API to get all the current attributes.

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

Update company partially

The "update company partially" API allows the user to update the attributes of a customer. To identify the customer, it is needed to provide:

• The issuer ID
• The customer reference (internal or external) for which updates are required

The customer reference can be retrieved by using the "List customers" API. With this API, only attributes that need to be updated must be given in input.

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

Retrieve company information by external reference

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

Update Company

The "update Company" API allows the user to update the attributes of a customer. To identify the customer, it is needed to provide:

• The issuer ID
• The customer reference (internal or external) for which updates are required

The customer reference can be retrieved by using the "list customers" API. All the attributes must be given in input even if they remain unchanged. For that, It can be needed to use the "retrieve customer" API to get all the current attributes.

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

Update Company partially

The "update customer partially" API allows the user to update the attributes of a customer. To identify the customer, it is needed to provide:

• The issuer ID
• The customer reference (internal or external) for which updates are required

The customer reference can be retrieved by using the "List customers" API. With this API, only attributes that need to be updated must be given in input.

GET /issuers/{issuerId}/companies

Retrieve list of company's information

POST /issuers/{issuerId}/companies

Create company

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

Retrieve company's Address information list

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

Create address for a company customer

The API creates an address for the customer, identified with his reference. 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.

For information, the main postal address is mandatory.

In return, the API provides the address Reference calculated by our system.

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

Retrieve company's address information by address ref

PUT /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}

Update company address

The API updates all the attributes of a customer's address identified with the reference of the customer and the reference of the address. All the attributes must be provided even those unchanged. The identifiers stay unchanged.

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

Retrieve company's address information by externalAddress

PUT /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}

Update company address

The API updates all the attributes of a customer's address identified with the reference of the customer and the reference of the address. All the attributes must be provided even those unchanged. The identifiers stay unchanged.

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

Retrieve company's Address information list by external reference

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

Create address for a company

The API creates an address for the customer, identified with his reference. 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.

For information, the main postal address is mandatory.

In return, the API provides the address Reference calculated by our system.

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

Retrieve address information by company external reference and address reference

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

Update company address

The API updates all the attributes of a customer's address identified with the reference of the customer and the reference of the address. All the attributes must be provided even those unchanged. The identifiers stay unchanged.

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

Retrieve address information by company external reference and address external reference

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

Update company address

The API updates all the attributes of a customer's address identified with the reference of the customer and the reference of the address. All the attributes must be provided even those unchanged. The identifiers stay unchanged.

POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/activate

Activate address of a company

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

Activate address of a company

POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate

Activate address of a company

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

Activate address of a company

POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/deactivate

Deactivate address of a company

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

Deactivate address of a company

POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate

Deactivate address of a company

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

Deactivate address of a company

POST /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages

Create an address usage for a company

This API allows to link a usage determined by its name (e.g. STATEMENT_SENDING), its entity reference (e.g. card contract reference) and its service code (e.g. ACCOUNT_SERVICE) and the address (identified with its internal reference) of a company (identified with its external reference).

DELETE /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}/address-usages

Remove an address usage of a company

The API deletes the address usages linked to one address. These address usages are filtered by the request params : addressUsageName (for definition see the ressource addressUsage), mandatory entityReference (for definition see the ressource addressUsage), optional serviceCode (for definition see the ressource addressUsage), mandatory If the entityReference is empty and the API finds several addresseUsages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted.

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages

Create an address usage for a company

The address usage describes for which business case the address will be used (e.g., statement sending, card delivery, ...). The complete authorized values list is shared during the product configuration between the issuer and WL. This API allows a usage determined by its name (e.g. STATEMENT_SENDING) to be linked to the entity reference of the address (e.g. card contract reference) and the service code (e.g. ACCOUNT_SERVICE)

DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}/address-usages

Remove an address usage of a company

The API deletes the address usages linked to one address. These address usages are filtered by the request params : addressUsageName (for definition see the ressource addressUsage), mandatory entityReference (for definition see the ressource addressUsage), optional serviceCode (for definition see the ressource addressUsage), mandatory If the entityReference is empty and the API finds several addresseUsages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted.

POST /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages

Create an address usage for a company

The address usage describes for which business case the address will be used (e.g., statement sending, card delivery, ...). The complete authorized values list is shared during the product configuration between the issuer and WL. This API allows a usage determined by its name (e.g. STATEMENT_SENDING) to be linked to the entity reference of the address (e.g. card contract reference) and the service code (e.g. ACCOUNT_SERVICE)

DELETE /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages

Remove an address usage of a company

The API deletes the address usages linked to one address. These address usages are filtered by the request params : addressUsageName (for definition see the ressource addressUsage), mandatory entityReference (for definition see the ressource addressUsage), optional serviceCode (for definition see the ressource addressUsage), mandatory If the entityReference is empty and the API finds several addresseUsages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted.

POST /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages

Create an address usage for a company

This API allows to link a usage determined by its name (e.g. STATEMENT_SENDING), its entity reference (e.g. card contract reference) and its service code (e.g. ACCOUNT_SERVICE) and the address (identified with its external reference) of a company (identified with its external reference).

DELETE /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages

Remove an address usage of a company

The API deletes the address usages linked to one address. These address usages are filtered by the request params : addressUsageName (for definition see the ressource addressUsage), mandatory entityReference (for definition see the ressource addressUsage), optional serviceCode (for definition see the ressource addressUsage), mandatory If the entityReference is empty and the API finds several addresseUsages (for the addressUsageName and serviceCode in request param), then the list of addressUsages will be deleted.

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

Retrieve corporate employee Accounts

This API allows retrieving a particular corporate employee accounts from its reference or its issuer external reference

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

Update Corporate employee account

The API allows to update a corporate Employee account

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

Retrieve corporate employee Accounts With External Account Ref

This API allows retrieving a particular corporate employee accounts from its reference or its issuer external reference

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

Update Corporate employee account by external account

The API allows to update a corporate Employee account

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

Retrieve corporate employee Accounts With External Contract Ref And External Account Ref

This API allows retrieving a particular corporate employee accounts from its reference or its issuer external reference

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

Update Corporate employee account by external contract and account

The API allows to update a corporate Employee account

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

Retrieve corporate employee Accounts With External Contract Ref

This API allows retrieving a particular corporate employee accounts from its reference or its issuer external reference

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

Update Corporate employee account By external contract

The API allows to update a corporate Employee account

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

List corporate contracts for a company

The API returns all the corporate contracts where the company belongs to

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

List corporate contracts for a company

The API returns all the corporate contracts where the company belongs to

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

Retrieve corporate contract

This API allows retrieving a particular corporate contract from its reference or its issuer external reference. The API response contains contract information such as:

• contract identifier with the contract reference and the issuer external contract reference if previously provided
• product change information if any, such as its current status (scheduled, done, cancelled), new product, new contract if it exists
• embedded fields if requested such as list of all customers or identifiers linked to this contract (e.g. contract owner, root account owner, cardholder(s)), card contracts, cards

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

Close Corporate contract

The API allows to close a corporate contract identified by the Contract reference. The contract can be closed immediately or in the future at a date provided by the issuer or at the card expiry date.

As result, For immediate closure : The contract is closed, the cards within the contract are deactivated, the closing is triggered for the accounts.

For scheduled closure : The contract is not changed until the closing date is reached. Once the closing date is reached, the contract is closed, the cards within the contract are deactivated, the closing is triggered for the accounts.

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

Close Corporate contract

The API allows to close a Corporate contract identified by the Issuer Contract external reference or the Contract reference. The contract can be closed immediately or in the future at a date provided by the issuer or at the card expiry date.

As result, For immediate closure : The contract is closed, the cards within the contract are deactivated, the closing is triggered for the accounts.

For scheduled closure : The contract is not changed until the closing date is reached. Once the closing date is reached, the contract is closed, the cards within the contract are deactivated, the closing is triggered for the accounts.

POST /issuers/{issuerId}/cards/declare-counterfeit-card

Declare counterfeit card

What's Changed

---

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

Response:

• Changed property data (object CardStates)
  • Added property expiryDate (string)
  • Added property status (string)
  • Added property blockingReason (string)

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

Response:

• Changed property data (object ForceProductChangeResponse)
  • Added property originalContract (object)
  • Added property changedContract (object)
  • Added property productChangeInformation (object)
  • Deleted property oldContract (object)
  • Deleted property newContract (object)

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

Response:

• Changed property data (object ForceProductChangeResponse)
  • Added property originalContract (object)
  • Added property changedContract (object)
  • Added property productChangeInformation (object)
  • Deleted property oldContract (object)
  • Deleted property newContract (object)

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

Response:

• Changed property data (object Card)
  • Added property logoReference (string)
  • Added property dispatchCode (string)
  • Added property automaticDeactivationDate (string)
  • Deleted property replacementForAutomaticDeactivationDate (string)
  • Changed property cardContract (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property logoReference (string)
        • Added property dispatchCode (string)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

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

Request body:

• Changed property replaceCardRequest (object ReplaceCardRequest)
  • Added property forceNewPIN (boolean)

Response:

• Changed property data (object BlockAndReplaceCardResponse)
  • Changed property replaceCardResponse (object ReplaceCardResponse)
    • Added property originalContract (object)
    • Added property changedContract (object)
    • Added property productChangeInformation (object)
    • Changed property card (object ReplaceCardResponse.Card)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)
    • Changed property newRelatedCardList (array)
      • Changed items (object ReplaceCardResponse)
        • Added property originalContract (object)
        • Added property changedContract (object)
        • Added property productChangeInformation (object)
        • Changed property card (object ReplaceCardResponse.Card)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object Order)
  • Changed property card (object Card)
    • Added property logoReference (string)
    • Added property dispatchCode (string)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)
    • Changed property cardContract (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Request body:

• Added property forceNewPIN (boolean)

Response:

• Changed property data (object ReplaceCardResponse)
  • Added property originalContract (object)
  • Added property changedContract (object)
  • Added property productChangeInformation (object)
  • Changed property card (object ReplaceCardResponse.Card)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)
  • Changed property newRelatedCardList (array)
    • Changed items (object ReplaceCardResponse)
      • Added property originalContract (object)
      • Added property changedContract (object)
      • Added property productChangeInformation (object)
      • Changed property card (object ReplaceCardResponse.Card)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object Card)
  • Added property logoReference (string)
  • Added property dispatchCode (string)
  • Added property automaticDeactivationDate (string)
  • Deleted property replacementForAutomaticDeactivationDate (string)
  • Changed property cardContract (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property logoReference (string)
        • Added property dispatchCode (string)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

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

Request body:

• Changed property replaceCardRequest (object ReplaceCardRequest)
  • Added property forceNewPIN (boolean)

Response:

• Changed property data (object BlockAndReplaceCardResponse)
  • Changed property replaceCardResponse (object ReplaceCardResponse)
    • Added property originalContract (object)
    • Added property changedContract (object)
    • Added property productChangeInformation (object)
    • Changed property card (object ReplaceCardResponse.Card)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)
    • Changed property newRelatedCardList (array)
      • Changed items (object ReplaceCardResponse)
        • Added property originalContract (object)
        • Added property changedContract (object)
        • Added property productChangeInformation (object)
        • Changed property card (object ReplaceCardResponse.Card)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object Order)
  • Changed property card (object Card)
    • Added property logoReference (string)
    • Added property dispatchCode (string)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)
    • Changed property cardContract (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Request body:

• Added property forceNewPIN (boolean)

Response:

• Changed property data (object ReplaceCardResponse)
  • Added property originalContract (object)
  • Added property changedContract (object)
  • Added property productChangeInformation (object)
  • Changed property card (object ReplaceCardResponse.Card)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)
  • Changed property newRelatedCardList (array)
    • Changed items (object ReplaceCardResponse)
      • Added property originalContract (object)
      • Added property changedContract (object)
      • Added property productChangeInformation (object)
      • Changed property card (object ReplaceCardResponse.Card)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object ChangeProductResponse)
  • Added property originalContract (object)
  • Added property changedContract (object)
  • Added property productChangeInformation (object)
  • Deleted property oldContract (object)
  • Deleted property newContract (object)

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

Response:

• Changed property data (object ChangeProductResponse)
  • Added property originalContract (object)
  • Added property changedContract (object)
  • Added property productChangeInformation (object)
  • Deleted property oldContract (object)
  • Deleted property newContract (object)

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

Response:

• Changed property data (object CreditTransfer)
  • Added property cancellationDate (string)

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

Response:

• Changed property data (object DirectDebit)
  • Added property cancellationDate (string)

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

Response:

• Changed property data (object Account)
  • Added property companyEntityExternalReference (string)
  • Deleted property companyAccountExternalReference (string)

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

Response:

• Changed property data (object GetAuthorizationResponse)
  • Changed property velocityLimitChecks (array)
    • Changed items (object VelocityLimitCheck)
      • Deleted property name (string)

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

Response:

• Changed property data (array)
  • Changed items (object CreditTransfer)
    • Added property cancellationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object DirectDebit)
    • Added property cancellationDate (string)

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

Response:

• Changed property data (object Account)
  • Added property companyEntityExternalReference (string)
  • Deleted property companyAccountExternalReference (string)

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

Response:

• Changed property data (object GetAuthorizationResponse)
  • Changed property velocityLimitChecks (array)
    • Changed items (object VelocityLimitCheck)
      • Deleted property name (string)

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

Response:

• Changed property data (array)
  • Changed items (object CreditTransfer)
    • Added property cancellationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object DirectDebit)
    • Added property cancellationDate (string)

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

Response:

• Changed property data (object CardContract)
  • Changed property cards (array)
    • Changed items (object Card)
      • Added property logoReference (string)
      • Added property dispatchCode (string)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Card)
    • Added property logoReference (string)
    • Added property dispatchCode (string)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object CardContract)
  • Changed property cards (array)
    • Changed items (object Card)
      • Added property logoReference (string)
      • Added property dispatchCode (string)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Card)
    • Added property logoReference (string)
    • Added property dispatchCode (string)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)

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 logoReference (string)
      • Added property dispatchCode (string)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Order)
    • Changed property card (object Card)
      • Added property logoReference (string)
      • Added property dispatchCode (string)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)
      • Changed property cardContract (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property logoReference (string)
            • Added property dispatchCode (string)
            • Added property automaticDeactivationDate (string)
            • Deleted property replacementForAutomaticDeactivationDate (string)

POST /issuers/{issuerId}/cards/search

Response:

• Changed property data (array)
  • Changed items (object Card)
    • Added property logoReference (string)
    • Added property dispatchCode (string)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object CardContract)
  • Changed property cards (array)
    • Changed items (object Card)
      • Added property logoReference (string)
      • Added property dispatchCode (string)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Order)
    • Changed property card (object Card)
      • Added property logoReference (string)
      • Added property dispatchCode (string)
      • Added property automaticDeactivationDate (string)
      • Deleted property replacementForAutomaticDeactivationDate (string)
      • Changed property cardContract (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property logoReference (string)
            • Added property dispatchCode (string)
            • Added property automaticDeactivationDate (string)
            • Deleted property replacementForAutomaticDeactivationDate (string)

POST /issuers/{issuerId}/cards/update-all-blocking-information

Response:

• Changed property data (array)
  • Changed items (object Card)
    • Added property logoReference (string)
    • Added property dispatchCode (string)
    • Added property automaticDeactivationDate (string)
    • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Authorization)
    • Changed property velocityLimitChecks (array)
      • Changed items (object VelocityLimitCheck)
        • Deleted property name (string)

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

Response:

• Changed property data (object Contract)
  • Added property contractClosedByProductChange (object)
  • Added property contractCreatedFromProductChange (object)
  • Deleted property productChangeInformation (object)
  • Changed property accounts (array)
    • Changed items (object Account)
      • Added property companyEntityExternalReference (string)
      • Deleted property companyAccountExternalReference (string)
  • Changed property cardContracts (array)
    • Changed items (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Authorization)
    • Changed property velocityLimitChecks (array)
      • Changed items (object VelocityLimitCheck)
        • Deleted property name (string)

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

Response:

• Changed property data (object Contract)
  • Added property contractClosedByProductChange (object)
  • Added property contractCreatedFromProductChange (object)
  • Deleted property productChangeInformation (object)
  • Changed property accounts (array)
    • Changed items (object Account)
      • Added property companyEntityExternalReference (string)
      • Deleted property companyAccountExternalReference (string)
  • Changed property cardContracts (array)
    • Changed items (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object Contract)
  • Added property contractClosedByProductChange (object)
  • Added property contractCreatedFromProductChange (object)
  • Deleted property productChangeInformation (object)
  • Changed property accounts (array)
    • Changed items (object Account)
      • Added property companyEntityExternalReference (string)
      • Deleted property companyAccountExternalReference (string)
  • Changed property cardContracts (array)
    • Changed items (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object Contract)
  • Added property contractClosedByProductChange (object)
  • Added property contractCreatedFromProductChange (object)
  • Deleted property productChangeInformation (object)
  • Changed property accounts (array)
    • Changed items (object Account)
      • Added property companyEntityExternalReference (string)
      • Deleted property companyAccountExternalReference (string)
  • Changed property cardContracts (array)
    • Changed items (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object SignContractResponse)
  • Changed property contract (object SignContractResponse.Contract)

    • New optional properties:

      • contractOwnerIdentifier
      • creationDate
      • productIdentifier

    • Deleted property creationDate (string)

    • Deleted property signatureDate (string)

    • Deleted property issuerBranchCode (string)

    • Deleted property cardReleaseOrder (string)

    • Deleted property productIdentifier (object)

    • Deleted property contractOwnerIdentifier (object)

    • Changed property accounts (array)

      • Changed items (object SignContractResponse.Account)

        • New optional properties:

          • accountGuarantorIdentifier
          • accountOwnerIdentifier

        • Deleted property accountOwnerIdentifier (object)

        • Deleted property accountGuarantorIdentifier (object)

    • Changed property cardContracts (array)

      • Changed items (object SignContractResponse.CardContract)

        • New required properties:

          • cardContractIdentifier
          • cards
          • status

        • New optional properties:

          • principalSupplementaryCardIndicator
          • relatedAccounts

        • Added property cards (array)

        • Deleted property cardHolderIdentifier (object)

        • Deleted property principalSupplementaryCardIndicator (string)

        • Deleted property card (object)

        • Deleted property relatedAccounts (array)

        • Deleted property externalCobadgedCardNumber (string)

        • Deleted property externalCobadgedSequenceNumber (string)

        • Deleted property externalCobadgedExpiryDate (string)

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

Response:

• Changed property data (object SignContractResponse)
  • Changed property contract (object SignContractResponse.Contract)

    • New optional properties:

      • contractOwnerIdentifier
      • creationDate
      • productIdentifier

    • Deleted property creationDate (string)

    • Deleted property signatureDate (string)

    • Deleted property issuerBranchCode (string)

    • Deleted property cardReleaseOrder (string)

    • Deleted property productIdentifier (object)

    • Deleted property contractOwnerIdentifier (object)

    • Changed property accounts (array)

      • Changed items (object SignContractResponse.Account)

        • New optional properties:

          • accountGuarantorIdentifier
          • accountOwnerIdentifier

        • Deleted property accountOwnerIdentifier (object)

        • Deleted property accountGuarantorIdentifier (object)

    • Changed property cardContracts (array)

      • Changed items (object SignContractResponse.CardContract)

        • New required properties:

          • cardContractIdentifier
          • cards
          • status

        • New optional properties:

          • principalSupplementaryCardIndicator
          • relatedAccounts

        • Added property cards (array)

        • Deleted property cardHolderIdentifier (object)

        • Deleted property principalSupplementaryCardIndicator (string)

        • Deleted property card (object)

        • Deleted property relatedAccounts (array)

        • Deleted property externalCobadgedCardNumber (string)

        • Deleted property externalCobadgedSequenceNumber (string)

        • Deleted property externalCobadgedExpiryDate (string)

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

Response:

• Changed property data (object Contract)
  • Added property contractClosedByProductChange (object)
  • Added property contractCreatedFromProductChange (object)
  • Deleted property productChangeInformation (object)
  • Changed property accounts (array)
    • Changed items (object Account)
      • Added property companyEntityExternalReference (string)
      • Deleted property companyAccountExternalReference (string)
  • Changed property cardContracts (array)
    • Changed items (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Account)
    • Added property companyEntityExternalReference (string)
    • Deleted property companyAccountExternalReference (string)

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

Response:

• Changed property data (array)
  • Changed items (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property logoReference (string)
        • Added property dispatchCode (string)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (object Contract)
  • Added property contractClosedByProductChange (object)
  • Added property contractCreatedFromProductChange (object)
  • Deleted property productChangeInformation (object)
  • Changed property accounts (array)
    • Changed items (object Account)
      • Added property companyEntityExternalReference (string)
      • Deleted property companyAccountExternalReference (string)
  • Changed property cardContracts (array)
    • Changed items (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property logoReference (string)
          • Added property dispatchCode (string)
          • Added property automaticDeactivationDate (string)
          • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Account)
    • Added property companyEntityExternalReference (string)
    • Deleted property companyAccountExternalReference (string)

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

Response:

• Changed property data (array)
  • Changed items (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property logoReference (string)
        • Added property dispatchCode (string)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Account)
    • Added property companyEntityExternalReference (string)
    • Deleted property companyAccountExternalReference (string)

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

Response:

• Changed property data (array)
  • Changed items (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property logoReference (string)
        • Added property dispatchCode (string)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Account)
    • Added property companyEntityExternalReference (string)
    • Deleted property companyAccountExternalReference (string)

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

Response:

• Changed property data (array)
  • Changed items (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property logoReference (string)
        • Added property dispatchCode (string)
        • Added property automaticDeactivationDate (string)
        • Deleted property replacementForAutomaticDeactivationDate (string)

POST /issuers/{issuerId}/contracts/search

Response:

• Changed property data (array)
  • Changed items (object Contract)
    • Added property contractClosedByProductChange (object)
    • Added property contractCreatedFromProductChange (object)
    • Deleted property productChangeInformation (object)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property companyEntityExternalReference (string)
        • Deleted property companyAccountExternalReference (string)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property logoReference (string)
            • Added property dispatchCode (string)
            • Added property automaticDeactivationDate (string)
            • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Contract)
    • Added property contractClosedByProductChange (object)
    • Added property contractCreatedFromProductChange (object)
    • Deleted property productChangeInformation (object)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property companyEntityExternalReference (string)
        • Deleted property companyAccountExternalReference (string)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property logoReference (string)
            • Added property dispatchCode (string)
            • Added property automaticDeactivationDate (string)
            • Deleted property replacementForAutomaticDeactivationDate (string)

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

Response:

• Changed property data (array)
  • Changed items (object Contract)
    • Added property contractClosedByProductChange (object)
    • Added property contractCreatedFromProductChange (object)
    • Deleted property productChangeInformation (object)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property companyEntityExternalReference (string)
        • Deleted property companyAccountExternalReference (string)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property logoReference (string)
            • Added property dispatchCode (string)
            • Added property automaticDeactivationDate (string)
            • Deleted property replacementForAutomaticDeactivationDate (string)

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

Request body:

• Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)
      • Added property techAndAppModelReference (string)
• Changed property contract (object CreateConsumerContractRequest.Contract)
  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)
      • Added property techAndAppModelReference (string)

Response:

• Changed property data (object CreateConsumerContractResponse)
  • Changed property contract (object CreateConsumerContractResponse.Contract)
    • Changed property cardContracts (array)
      • Changed items (object CreateConsumerContractResponse.CardContract)
        • Added property originalCardContractIdentifier (object)
        • Added property changedCardContractIdentifier (object)

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

Request body:

• Changed property cardContracts (array)
  • Changed items (object CreateConsumerContractRequest.CardContract)
    • Added property techAndAppModelReference (string)

Response:

• Changed property data (object AddCardsAccountsResponse)
  • Changed property contract (object CreateConsumerContractResponse.Contract)
    • Changed property cardContracts (array)
      • Changed items (object CreateConsumerContractResponse.CardContract)
        • Added property originalCardContractIdentifier (object)
        • Added property changedCardContractIdentifier (object)

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

Request body:

• Changed property cardContracts (array)
  • Changed items (object CreateConsumerContractRequest.CardContract)
    • Added property techAndAppModelReference (string)

Response:

• Changed property data (object AddCardsAccountsResponse)
  • Changed property contract (object CreateConsumerContractResponse.Contract)
    • Changed property cardContracts (array)
      • Changed items (object CreateConsumerContractResponse.CardContract)
        • Added property originalCardContractIdentifier (object)
        • Added property changedCardContractIdentifier (object)