REST API V2 - 2.9.0

  • Version 2.8.1 to 2.9.0
  • What's New
  • What's Changed
  • What's Deleted
  • What's Deprecated

What's New

Add an entity to a Corporate contract

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

The API allows to add an entity to a corporate contract identified by the Contract reference.

Modify an entity of a Corporate contract

PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference}

The API allows to modify an entity to a corporate contract identified by the Contract reference.

modify an entity of a Corporate contract

PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-contract-entity/{companyEntityExternalReference}

The API allows to modify an entity to a corporate contract identified by the Contract reference.

Add an entity to a Corporate contract

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

The API allows to add an entity to a corporate contract identified by the Issuer Contract external reference.

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

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

The API allows to add an entity to a corporate contract identified by the Issuer Contract external reference.

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

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

The API allows to add an employee and its card(s) and account(s) to a corporate contract identified by the Contract reference.

 

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

The API allows to add an employee and its card(s) and account(s) to a corporate contract identified by the Issuer Contract external reference.

Create a Corporate contract

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

The Create Corporate Contract API allows the creation of a new corporate contract with the company organization (complete or partial structure).

Modify an entity of a Corporate contract

PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference}

The API allows to modify an entity to a corporate contract identified by the Contract reference.

Pre-conditions: The correlation ID, if provided by the issuer, must be unique. In case of re-use of a correlation ID from an existing corporate contract, the system will return the data from the existing corporate contract (e.g., if the API call returns a "time-out" response, the same correlation ID can be provided to retrieve corporate contract data from Worldline system for further checks).

During the corporate contract creation

  1. The issuer can provide a list of new customers/companies, otherwise the references to existing customers/companies in Worldline system can be used
  2. The issuer has the possibility to create
  • the company organization, by adding 1 or several corporate entities such as countries, divisions, departments (this is also possible afterwards with dedicated API)
  • the employees with their cards and accounts (this is also possible afterwards with dedicated API)

As a result, the contract is created:

  • with its own reference calculated by our system
  • with the status set to "Signed"
  • with entity levels of the company organization (at least the company itself)
  • with the root entity account

The API response returns

  • the different identifiers related to the corporate contract, such as the contract itself, contract owner, account owner of an entity
  • if requested identifiers of employee accounts, card contracts, cards and cardholders if any (each identifier is composed of the Worldline internal reference and, optionally, the external reference if provided by the issuer in the request)

The references are used to: retrieve/update/close corporate contracts, retrieve the list of entities for a corporate contract, retrieve the corporate employee account, etc.

Retrieve the list of add-on services

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

The API allows to retrieve the list of add-on subscriptions for a contract.

Subscribe to add-on

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions

The API allows to subscribe to an add-on service for a contract

Unsubscribe add-on

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe

The API allows to unsubscribe from an add-on service.

Retrieve the list of add-on services

GET /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions

The API allows to retrieve the list of add-on subscriptions for a contract.

Subscribe to add-on

POST /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions

The API allows to subscribe to an add-on service for a contract.

Unsubscribe add-on

POST /issuers/{issuerId}/contracts/{contractReference}/addon-subscriptions/unsubscribe

The API allows to unsubscribe from add-on service

Invalidate address

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

The API allows to invalidate on demand an address by providing.

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Invalidate address

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

The API allows to invalidate on demand an address by providing

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Invalidate address

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/invalidate

The API allows activation on demand of an address by providing

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Invalidate address

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/invalidate

The API allows activation on demand of an address by providing

  • the reference of the customer,
  • the reference of the address
  • the issuer Id.

Modify Contact by customer reference and contact reference

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

The API allows information of a contact of the company to be modified. All attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty.

Modify Contact by issuer customer external reference and contact reference

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

The API allows information of a contact of the company to be modified. All attributes must be provided (even if some of them have not been modified) else the value of missing attributes will be empty.

What's Changed

GET /health
Parameters:

Added: WL-Origin in header

GET /info
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

PUT /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/credit-limit
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-fee-operation
Parameters:

Added: WL-Origin in header

Request body:
  • New required properties:

    • adjustment
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-reimbursement-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-load-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-unload-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-fee-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reverse-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/reprint
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/reprint
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

PUT /issuers/{issuerId}/accounts/{accountReference}/credit-limit
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-fee-operation
Parameters:

Added: WL-Origin in header

Request body:
  • New required properties:

    • adjustment
POST /issuers/{issuerId}/accounts/{accountReference}/post-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-reimbursement-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-load-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/post-unload-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/reverse-balance-adjustment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/reverse-fee-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/reverse-payment-operation
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/statements/last/reprint
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/reprint
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/create-mandate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/cancel-mandate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/deactivate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}/release
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/remind-pin
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/unblock
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/deactivate
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}/release
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/remind-pin
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/unblock
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents/{customerReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/terminate-all
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/cancel
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/repay
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}/terminate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-transfers/{endToEndId}/cancel
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/direct-debits
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/direct-debits/{endToEndId}/cancel
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/postings
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/postings
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/events
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/events
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/{disputeFolderReference}/generate-chargeback
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/generate-chargeback
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

DELETE /issuers/{issuerId}/companies/{customerReference}/contacts/{contactReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/cancel-delinquency
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/cancel-delinquency
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}/insurance-events
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/card-contracts/{cardContractReference}/cancel-close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cancel-close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/card-contracts/{cardContractReference}/close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/block-all
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Request body:
  • Changed property replaceCardRequest (object ReplaceCardRequest)

    • Added property forceNewPin (boolean)
    • Deleted property forceNewPIN (boolean)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/new-tan
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/reorder-pin
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Request body:
  • Added property forceNewPin (boolean)
  • Deleted property forceNewPIN (boolean)
POST /issuers/{issuerId}/cards/unblock-all
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/block
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Request body:
  • Changed property replaceCardRequest (object ReplaceCardRequest)

    • Added property forceNewPin (boolean)
    • Deleted property forceNewPIN (boolean)
GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/reorder-pin
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Request body:
  • Added property forceNewPin (boolean)
  • Deleted property forceNewPIN (boolean)
GET /issuers/{issuerId}/cards/{cardReference}/blocking-information
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/cards/{cardReference}/blocking-information
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object BlockAllCardsResponse)

      • New required properties:

        • cards

      • New optional properties:

        • issuerId

      • Added property cards (array)

      • Deleted property issuerId (string)

      • Deleted property cardIdentifier (object)

      • Deleted property encryptedPan (object)

      • Deleted property pan (string)

      • Deleted property maskedPan (string)

      • Deleted property panReference (string)

      • Deleted property expiryDate (string)

      • Deleted property panSequenceNumber (string)

      • Deleted property status (string)

      • Deleted property statusDate (string)

      • Deleted property statusHistory (array)

      • Deleted property embossingName (string)

      • Deleted property embossingName2ndLine (string)

      • Deleted property embossingLine5 (string)

      • Deleted property artwork (string)

      • Deleted property permanentlyBlocked (boolean)

      • Deleted property emergencyCard (boolean)

      • Deleted property emergencyCashAdvance (boolean)

      • Deleted property renewed (boolean)

      • Deleted property replaced (boolean)

      • Deleted property replacementReason (string)

      • Deleted property blockingReason (string)

      • Deleted property pinInheritanceCardReference (string)

      • Deleted property specificFields (object)

      • Deleted property renewedBy (object)

      • Deleted property replacementBy (object)

      • Deleted property renewedFor (object)

      • Deleted property replacementFor (object)

      • Deleted property cardContractIdentifier (object)

      • Deleted property cardContract (object)

      • Deleted property orderIdentifiers (array)

      • Deleted property isCardDigitalizationAllowed (boolean)

      • Deleted property multiCardInfo (object)

      • Deleted property cardScheme (string)

      • Deleted property virtual (boolean)

      • Deleted property contactlessEnabled (boolean)

      • Deleted property technologyType (string)

      • Deleted property techAndAppModelName (string)

      • Deleted property photoReference (string)

      • Deleted property pictureReference (string)

      • Deleted property logoReference (string)

      • Deleted property dispatchCode (string)

      • Deleted property automaticDeactivationDate (string)

      • Deleted property contractType (string)

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/cancel-suspend
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/{accountReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/legitimacy-documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-close
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/cancel-suspend
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/{contractReference}/contract-fees/{accountReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/contracts/{contractReference}/contract-fees/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/{contractReference}/legitimacy-documents
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/simulate
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/credit-instalments/{creditInstalmentReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-transfers
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/activate
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}/deactivate
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/activate
Parameters:

Added: WL-Origin in header

DELETE /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/address-usages
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses/{addressReference}/deactivate
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/operations/{operationId}/disputes
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/operations/{operationId}/dispute
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/{cardReference}/new-tan
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • Added property panReference (string)
    • Added property status (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CreateEmergencyCardResponse)

    • Added property panReference (string)
    • Added property status (string)
PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property hierarchyOutgoingCreditTransferFeature (object ModifyHierarchyOutgoingCreditTransferFeature)

    • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object Account)

    • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

      • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-history
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

PATCH /issuers/{issuerId}/accounts/{accountReference}
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property hierarchyOutgoingCreditTransferFeature (object ModifyHierarchyOutgoingCreditTransferFeature)

    • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/{accountReference}
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object Account)

    • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

      • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/account-guarantor
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/account-history
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

PATCH /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

PATCH /issuers/{issuerId}/card-contracts/{cardContractReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-events
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/cards/search
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/cards/{cardReference}/card-events
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-fees
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/{contractReference}/contract-fees
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/contracts/{contractReference}/contract-owner
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/credit-instalments/
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/credit-instalments/
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses
Parameters:

Added: WL-Origin in header

PUT /issuers/{issuerId}/customers/{customerReference}
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/customers/{customerReference}
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers/{customerReference}
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/customers/{customerReference}/addresses
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/companies
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/companies
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateEmployeeAccountResponse)

    • Changed property account (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/card-contracts
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CloseContractResponse)

    • Changed property contract (object CloseContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object CloseContractResponse.CardContract)

          • Changed property cards (array)

            • Changed items (object CloseContractResponse.Card)

              • Added property panReference (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/update-all-customers-addresses
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Added property closingDate (string)
      • Changed property cardContracts (array)
        • Changed items (object SuspendContractResponse.CardContract)

          • Added property replacementBlockingReason (string)
          • Added property renewalBlockingReason (string)
          • Changed property cards (array)
            • Changed items (object SuspendContractResponse.Card)

              • Added property panReference (string)
PATCH /issuers/{issuerId}/contracts/{contractReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (object Contract)

    • Added property addonSubscriptions (array)
    • Changed property accounts (array)
      • Changed items (object Account)

        • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

          • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/contracts/{contractReference}/card-contracts
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/{contractReference}/close
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (object CloseContractResponse)

    • Changed property contract (object CloseContractResponse.Contract)

      • Changed property cardContracts (array)

        • Changed items (object CloseContractResponse.CardContract)

          • Changed property cards (array)

            • Changed items (object CloseContractResponse.Card)

              • Added property panReference (string)
POST /issuers/{issuerId}/contracts/{contractReference}/update-all-customers-addresses
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object SuspendContractResponse)

    • Changed property contract (object SuspendContractResponse.Contract)

      • Added property closingDate (string)
      • Changed property cardContracts (array)
        • Changed items (object SuspendContractResponse.CardContract)

          • Added property replacementBlockingReason (string)
          • Added property renewalBlockingReason (string)
          • Changed property cards (array)
            • Changed items (object SuspendContractResponse.Card)

              • Added property panReference (string)
POST /issuers/{issuerId}/contracts/{contractReference}/switch-principal-card
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/switch-principal-card
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/corporate-contracts/{contractReference}/change-paying-account
Parameters:

Added: WL-Origin in header

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/change-paying-account
Parameters:

Added: WL-Origin in header

GET /issuers/{issuerId}/customers
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/card-contracts
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Account)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/customers/{customerReference}/card-contracts
Parameters:

Added: WL-Origin in header

PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateContract)

    • Changed property corporateContractEntities (array)

      • Changed items (object CorporateContractEntity)

        • Added property deliveryChannel (object)
        • Added property advertisementFlags (object)
        • Changed property account (object Account)
          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
PATCH /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (object CorporateContract)

    • Changed property corporateContractEntities (array)

      • Changed items (object CorporateContractEntity)

        • Added property deliveryChannel (object)
        • Added property advertisementFlags (object)
        • Changed property account (object Account)
          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)

        • Changed property account (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/contracts/{contractReference}/sign
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

POST /issuers/{issuerId}/contracts/search
Parameters:

Added: WL-Origin in header
Changed: embed in query

Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Added property addonSubscriptions (array)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/contracts/{contractReference}/change-product
Parameters:

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

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

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Added property addonSubscriptions (array)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object Contract)

      • Added property addonSubscriptions (array)
      • Changed property accounts (array)
        • Changed items (object Account)

          • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

            • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property corporateContractEntities (array)

        • Changed items (object CorporateContractEntity)

          • Added property deliveryChannel (object)
          • Added property advertisementFlags (object)
          • Changed property account (object Account)
            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Parameters:

Added: WL-Origin in header

Response:
  • Changed property data (array)

    • Changed items (object CorporateContract)

      • Changed property corporateContractEntities (array)

        • Changed items (object CorporateContractEntity)

          • Added property deliveryChannel (object)
          • Added property advertisementFlags (object)
          • Changed property account (object Account)
            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)

          • Changed property account (object Account)

            • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

              • Added property octOnContractSuspensionAllowed (boolean)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)

    • Changed property accounts (array)

      • Changed items (object CreateConsumerContractRequest.Account)

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

        • Added property contractAddOnsSubscriptions (array)
  • Changed property contract (object CreateConsumerContractRequest.Contract)
    • Changed property accountHierarchy (object CreateConsumerContractRequest.AccountHierarchy)

      • Changed property hierarchyOutgoingCreditTransferFeature (object HierarchyOutgoingCreditTransferFeature)

        • Added property octOnContractSuspensionAllowed (boolean)
      • Changed property accounts (array)
        • Changed items (object CreateConsumerContractRequest.Account)

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

        • Added property contractAddOnsSubscriptions (array)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)

    • Changed property accounts (array)

      • Changed items (object CreateConsumerContractRequest.Account)

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

      • Added property contractAddOnsSubscriptions (array)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Parameters:

Added: WL-Origin in header

Request body:
  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)

    • Changed property accounts (array)

      • Changed items (object CreateConsumerContractRequest.Account)

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

      • Added property contractAddOnsSubscriptions (array)

What's Deleted

Modify Contact by customer reference and contact reference

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

Modify Contact by customer reference and contact reference

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

What's Deprecated

 

No API deprecated.

Enable "on this page" menu on doc section
On