Getting Started with FIDO Server by Worldline

Prerequisites​

You need to keep your client_id and secret_id that was sent to you by mail.

If you lost your secret_id, please contact us to generate a new one for you.

These credentials are needed for all interactions with the Fido Server by Worldline.

You also need the audience to access generate bearer tokens.

OAuth2 Server URL  : https://access.fido.worldline-solutions.com

Audience : https://my-wafl-api-gateway-6glqflxv.ew.gateway.dev  - to update 

API access and authentication

The FIDO Server by Worldline (also called WAFL Server) API uses the OAuth Client Credentials Flow to authenticate API calls.


Request tokens

Example using curl
curl --request POST \
    --url 'https://access.fido.dev.worldline-solutions.com/oauth2/token' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --header 'Authorization: Basic Base64Encode(concat('client_id', ':', 'client_secret'))' \
    --data 'grant_type=client_credentials' \
    --data 'audience=https://my-wafl-api-gateway-206w9c7e.ew.gateway.dev'
Parameters
  • grant_type : set this to your "client_credentials"
  • audience : the audiance for the token (see the prerequisites)
Response

If all goes well, you'll receive an HTTP 200 response with a payload containing access_token, and expires_in values:

{
  "access_token": "eyJz93a...k4laUWw",
  "expires_in": 3600
}
Access token lifetime

The lifetime of a token is set to 3600 seconds

Enable "on this page" menu on doc section
On

Transaction

Transaction

Retrieve Transaction Details

The API allows the transaction details to be retrieved.

The main input fields are:

  • The issuer ID
  • The transaction for which the detail is requested: It is provided by using the transaction Id.

It is also possible to request some additional data relative to addendum (to retrieve lodging information, car rental information, air itinerary information) by using the embedded fields.

In return, the interface provides the generic information (mainly master data) relevant to the transaction.

API links

Search Transactions (Global)

The API provides possibility to retrieve a list of transactions (original first presentments received from the card schemes), based on certain criteria.

At least one of the following criteria for searching must be provided:

  • PAN
  • PAN token
  • Transaction identifier
  • Acquirer reference number
  • Virtual Service Card Number

If requested, the API allows also to:

  • search from an issuer and optionally with sub-issuers (by default, the search is performed on all issuers allowed for the user depending on its rights)
  • return only certain transactions (disputed transactions, fraudulent transactions)
  • request to enrich the response with additional data relative to addendum (to retrieve lodging information, car rental information, air itinerary information) by using embedded fields

The API response contains all matched transactions sorted by descending transaction date.

API links

Enable "on this page" menu on doc section
On

Release Notes: Recent Update

Release Notes: Recent Update

Version 2.24.1 to 2.26.1

What's New

POST /api/v2/issuers/{issuerId}/accounts/{accountReference}/authorization-restrictions/search

Search authorization restrictions by account reference

 

What's Changed

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

Response:

  • Changed property data (object Account)
    • Changed property externalVelocityLimits (array)
      • Changed items (object ExternalVelocityLimit)
        • Added property activationStartTime (string)
        • Added property activationEndTime (string)
        • Deleted property startDate (string)
        • Deleted property endDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}

Response:

  • Changed property data (object Account)
    • Changed property externalVelocityLimits (array)
      • Changed items (object ExternalVelocityLimit)
        • Added property activationStartTime (string)
        • Added property activationEndTime (string)
        • Deleted property startDate (string)
        • Deleted property endDate (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/customers/{customerReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/accounts/{accountReference}/corporate-contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Changed property externalVelocityLimits (array)
        • Changed items (object ExternalVelocityLimit)
          • Added property activationStartTime (string)
          • Added property activationEndTime (string)
          • Deleted property startDate (string)
          • Deleted property endDate (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}

Response:

  • Changed property data (object CorporateContract)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Changed property externalVelocityLimits (array)
            • Changed items (object ExternalVelocityLimit)
              • Added property activationStartTime (string)
              • Added property activationEndTime (string)
              • Deleted property startDate (string)
              • Deleted property endDate (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

Response:

  • Changed property data (object CorporateContract)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Changed property externalVelocityLimits (array)
            • Changed items (object ExternalVelocityLimit)
              • Added property activationStartTime (string)
              • Added property activationEndTime (string)
              • Deleted property startDate (string)
              • Deleted property endDate (string)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Request body :
  • Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Request body :

  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
POST /issuers/{issuerId}/contracts/search

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Changed property externalVelocityLimits (array)
            • Changed items (object ExternalVelocityLimit)
              • Added property activationStartTime (string)
              • Added property activationEndTime (string)
              • Deleted property startDate (string)
              • Deleted property endDate (string)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

Request body :

  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Changed property externalVelocityLimits (array)
          • Changed items (object ExternalVelocityLimit)
            • Added property activationStartTime (string)
            • Added property activationEndTime (string)
            • Deleted property startDate (string)
            • Deleted property endDate (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Changed property externalVelocityLimits (array)
            • Changed items (object ExternalVelocityLimit)
              • Added property activationStartTime (string)
              • Added property activationEndTime (string)
              • Deleted property startDate (string)
              • Deleted property endDate (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Changed property externalVelocityLimits (array)
            • Changed items (object ExternalVelocityLimit)
              • Added property activationStartTime (string)
              • Added property activationEndTime (string)
              • Deleted property startDate (string)
              • Deleted property endDate (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Changed property externalVelocityLimits (array)
              • Changed items (object ExternalVelocityLimit)
                • Added property activationStartTime (string)
                • Added property activationEndTime (string)
                • Deleted property startDate (string)
                • Deleted property endDate (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Changed property externalVelocityLimits (array)
              • Changed items (object ExternalVelocityLimit)
                • Added property activationStartTime (string)
                • Added property activationEndTime (string)
                • Deleted property startDate (string)
                • Deleted property endDate (string)
POST /search-contracts
Response:
  • Changed property data (object ApiResponseEntityListContract)
    • Changed property data (array)
      • Changed items (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Changed property externalVelocityLimits (array)
              • Changed items (object ExternalVelocityLimit)
                • Added property activationStartTime (string)
                • Added property activationEndTime (string)
                • Deleted property startDate (string)
                • Deleted property endDate (string)
POST /search-corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Changed property externalVelocityLimits (array)
              • Changed items (object ExternalVelocityLimit)
                • Added property activationStartTime (string)
                • Added property activationEndTime (string)
                • Deleted property startDate (string)
                • Deleted property endDate (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
GET /issuers/{issuerId}/accounts/{accountReference}/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • Added property cardAcceptorZipCode (string)
POST /search-operations

Response:

  • Changed property data (object ApiResponseEntityListOperation)
    • Changed property data (array)
      • Changed items (object Operation)
        • Added property cardAcceptorZipCode (string)
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/post-reimbursement-operation

Request body :

  • Added property destinationIban (string)
POST /issuers/{issuerId}/accounts/{accountReference}/post-reimbursement-operation

Request body :

  • Added property destinationIban (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}

Response:

  • Changed property data (object Order)
    • Changed property card (object Card)
      • Added property pinInheritanceCardIdentifier (object)
      • Changed property cardContract (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}

Response:

  • Changed property data (object Order)
    • Changed property card (object Card)
      • Added property pinInheritanceCardIdentifier (object)
      • Changed property cardContract (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Added property pinInheritanceCardIdentifier (object)
POST /search-operations

Response:

  • Changed property data (object -> array)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}

Response:

  • Changed property data (object Card)
    • Added property pinInheritanceCardIdentifier (object)
    • Changed property cardContract (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property pinInheritanceCardIdentifier (object)
    • Changed property orders (array)
      • Changed items (object Order)
        • Changed property card (object Card)
          • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders

Response:

  • Changed property data (array)
    • Changed items (object Order)
      • Changed property card (object Card)
        • Added property pinInheritanceCardIdentifier (object)
        • Changed property cardContract (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/cards/{cardReference}

Response:

  • Changed property data (object Card)
    • Added property pinInheritanceCardIdentifier (object)
    • Changed property cardContract (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property pinInheritanceCardIdentifier (object)
    • Changed property orders (array)
      • Changed items (object Order)
        • Changed property card (object Card)
          • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/cards/{cardReference}/orders

Response:

  • Changed property data (array)
    • Changed items (object Order)
      • Changed property card (object Card)
        • Added property pinInheritanceCardIdentifier (object)
        • Changed property cardContract (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property pinInheritanceCardIdentifier (object)
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 pinInheritanceCardIdentifier (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards

Response:

  • Changed property data (array)
    • Changed items (object Card)
      • Added property pinInheritanceCardIdentifier (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}

Response:

  • Changed property data (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property pinInheritanceCardIdentifier (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cards

Response:

  • Changed property data (array)
    • Changed items (object Card)
      • Added property pinInheritanceCardIdentifier (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace

Request body :

  • Changed property replaceCardRequest (object ReplaceCardRequest)
    • Changed property cardContract (object ReplaceCardRequest.CardContract)
      • Changed property card (object ReplaceCardRequest.CardContract.Card)
        • Added property externalAuthorizationsRestrictions (array)
        • Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
          • Changed property specificFields (string -> object)
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 pinInheritanceCardIdentifier (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace

Request body :

  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property card (object ReplaceCardRequest.CardContract.Card)
      • Added property externalAuthorizationsRestrictions (array)
      • Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
        • Changed property specificFields (string -> object)
POST /issuers/{issuerId}/cards/search

Response:

  • Changed property data (array)
    • Changed items (object Card)
      • Added property pinInheritanceCardIdentifier (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/cards/{cardReference}/block-and-replace

Request body :

  • Changed property replaceCardRequest (object ReplaceCardRequest)
    • Changed property cardContract (object ReplaceCardRequest.CardContract)
      • Changed property card (object ReplaceCardRequest.CardContract.Card)
        • Added property externalAuthorizationsRestrictions (array)
        • Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
          • Changed property specificFields (string -> object)
GET /issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
  • Changed property data (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property pinInheritanceCardIdentifier (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/cards/{cardReference}/replace

Request body :

  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property card (object ReplaceCardRequest.CardContract.Card)
      • Added property externalAuthorizationsRestrictions (array)
      • Changed property pinMailerOrder (object ReplaceCardRequest.PinMailerOrder)
        • Changed property specificFields (string -> object)
POST /search-contracts

Response:

  • Changed property data (object -> array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/accounts/{accountReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/accounts/{accountReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/

Response:

  • Changed property data (array)
    • Changed items (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property pinInheritanceCardIdentifier (object)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object CorporateEmployeeAccount)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
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 pinInheritanceCardIdentifier (object)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/contracts/{contractReference}

Response:

  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property pinInheritanceCardIdentifier (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
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 pinInheritanceCardIdentifier (object)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Added property pinInheritanceCardIdentifier (object)
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 pinInheritanceCardIdentifier (object)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Added property pinInheritanceCardIdentifier (object)
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 pinInheritanceCardIdentifier (object)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}

Response:

  • Changed property data (object CorporateContract)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)
            • Changed property cards (array)
              • Changed items (object Card)
                • Added property pinInheritanceCardIdentifier (object)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Changed property card (object Card)
                      • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

Response:

  • Changed property data (object CorporateContract)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)
            • Changed property cards (array)
              • Changed items (object Card)
                • Added property pinInheritanceCardIdentifier (object)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Changed property card (object Card)
                      • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/contracts/create-consumer-contract

Request body :

  • Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
    • Changed property cardContracts (array)
      • Changed items (object CreateConsumerContractRequest.CardContract)
        • Changed property card (object CreateConsumerContractRequest.Card)
          • Added property pinInheritanceCardIdentifier (object)
          • Added property externalAuthorizationsRestrictions (array)
          • Deleted property brandChangePreviousCardReference (string)
          • Deleted property brandChangeReplacementReason (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Request body :

  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)
      • Changed property card (object CreateConsumerContractRequest.Card)
        • Added property pinInheritanceCardIdentifier (object)
        • Added property externalAuthorizationsRestrictions (array)
        • Deleted property brandChangePreviousCardReference (string)
        • Deleted property brandChangeReplacementReason (string)
POST /issuers/{issuerId}/contracts/search

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property pinInheritanceCardIdentifier (object)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                    • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

Request body :

  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)
      • Changed property card (object CreateConsumerContractRequest.Card)
        • Added property pinInheritanceCardIdentifier (object)
        • Added property externalAuthorizationsRestrictions (array)
        • Deleted property brandChangePreviousCardReference (string)
        • Deleted property brandChangeReplacementReason (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property pinInheritanceCardIdentifier (object)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                    • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/customers/{customerReference}/contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property pinInheritanceCardIdentifier (object)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                    • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)
              • Changed property cards (array)
                • Changed items (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Changed property card (object Card)
                        • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)
              • Changed property cards (array)
                • Changed items (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Changed property card (object Card)
                        • Added property pinInheritanceCardIdentifier (object)
POST /search-corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)
              • Changed property cards (array)
                • Changed items (object Card)
                  • Added property pinInheritanceCardIdentifier (object)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Changed property card (object Card)
                        • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-account

Request body :

  • Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
    • Changed property corporateEmployeeCards (array)
      • Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
        • Changed property cardContract (object CreateCorporateContractRequest.CardContract)
          • Changed property card (object CreateCorporateContractRequest.Card)
            • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts

Request body :

  • Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
    • Changed property corporateEmployeeCards (array)
      • Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
        • Changed property cardContract (object CreateCorporateContractRequest.CardContract)
          • Changed property card (object CreateCorporateContractRequest.Card)
            • Added property pinInheritanceCardIdentifier (object)
POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract

Request body :

  • Changed property addCorporateEmployeeCardsAndAccounts (array)
    • Changed items (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
      • Changed property corporateEmployeeCards (array)
        • Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
          • Changed property cardContract (object CreateCorporateContractRequest.CardContract)
            • Changed property card (object CreateCorporateContractRequest.Card)
              • Added property pinInheritanceCardIdentifier (object)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}

Response:

  • Changed property data (object Account)
    • Changed property externalAuthorizationsRestrictions (array)
      • Changed items (object ExternalAuthorizationsRestriction)
        • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/accounts/{accountReference}

Response:

  • Changed property data (object Account)
    • Changed property externalAuthorizationsRestrictions (array)
      • Changed items (object ExternalAuthorizationsRestriction)
        • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace

Request body :

  • Changed property replaceCardRequest (object ReplaceCardRequest)
    • Changed property cardContract (object ReplaceCardRequest.CardContract)
      • Changed property card (object ReplaceCardRequest.CardContract.Card)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace

Request body :

  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property card (object ReplaceCardRequest.CardContract.Card)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/cards/{cardReference}/block-and-replace

Request body :

  • Changed property replaceCardRequest (object ReplaceCardRequest)
    • Changed property cardContract (object ReplaceCardRequest.CardContract)
      • Changed property card (object ReplaceCardRequest.CardContract.Card)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/cards/{cardReference}/replace

Request body :

  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property card (object ReplaceCardRequest.CardContract.Card)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/customers/{customerReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/accounts/{accountReference}/corporate-contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

Parameters:

Changed: embed in query

Response:
  • Changed property data (object CorporateEmployeeAccount)
    • Added property customerIdentifiers (array)
    • Added property customers (array)
    • Changed property account (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Parameters:

Changed: embed in query

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Added property customerIdentifiers (array)
    • Added property customers (array)
    • Changed property account (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Parameters:

Changed: embed in query

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Added property customerIdentifiers (array)
    • Added property customers (array)
    • Changed property account (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

Parameters:

Changed: embed in query

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Added property customerIdentifiers (array)
    • Added property customers (array)
    • Changed property account (object Account)
      • Changed property externalAuthorizationsRestrictions (array)
        • Changed items (object ExternalAuthorizationsRestriction)
          • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/contracts/{contractReference}

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}

Parameters:

Changed: embed in query

Response:

  • Changed property data (object CorporateContract)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Changed property externalAuthorizationsRestrictions (array)
            • Changed items (object ExternalAuthorizationsRestriction)
              • Deleted property conditionParameters (string)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Added property customerIdentifiers (array)
        • Added property customers (array)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

Parameters:

Changed: embed in query

Response:
  • Changed property data (object CorporateContract)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Changed property externalAuthorizationsRestrictions (array)
            • Changed items (object ExternalAuthorizationsRestriction)
              • Deleted property conditionParameters (string)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Added property customerIdentifiers (array)
        • Added property customers (array)
POST /search-contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Changed property externalAuthorizationsRestrictions (array)
            • Changed items (object ExternalAuthorizationsRestriction)
              • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/contracts/create-consumer-contract

Request body 

  • Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Request body :

  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/contracts/search

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Changed property externalAuthorizationsRestrictions (array)
            • Changed items (object ExternalAuthorizationsRestriction)
              • Deleted property conditionParameters (string)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

Request body :

  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Changed property externalAuthorizationsRestrictions (array)
          • Changed items (object ExternalAuthorizationsRestriction)
            • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Changed property externalAuthorizationsRestrictions (array)
            • Changed items (object ExternalAuthorizationsRestriction)
              • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Changed property externalAuthorizationsRestrictions (array)
            • Changed items (object ExternalAuthorizationsRestriction)
              • Deleted property conditionParameters (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Changed property externalAuthorizationsRestrictions (array)
              • Changed items (object ExternalAuthorizationsRestriction)
                • Deleted property conditionParameters (string)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Added property customerIdentifiers (array)
          • Added property customers (array)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Changed property externalAuthorizationsRestrictions (array)
              • Changed items (object ExternalAuthorizationsRestriction)
                • Deleted property conditionParameters (string)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Added property customerIdentifiers (array)
          • Added property customers (array)
POST /search-corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Changed property externalAuthorizationsRestrictions (array)
              • Changed items (object ExternalAuthorizationsRestriction)
                • Deleted property conditionParameters (string)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Added property customerIdentifiers (array)
          • Added property customers (array)

What's Deleted

No API deleted.

 

Enable "on this page" menu on doc section
On

REST API V2 - 2.24.0

REST API V2 - 2.24.0

Version 2.23.1 to 2.24.0

What's New

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

Retrieve corporate contract for an account by external reference (beta)

The API enables the corporate contract data for a given account to be retrieved.

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

Retrieve an operation by external references triplet and account external reference (beta)

The API allows to retrieve an operation using its external operation references for the given account by using issuer account external reference or the account reference (generated by WL).

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

Retrieve corporate contract for an account (beta)

The API enables the corporate contract data for a given account to be retrieved.

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

Retrieve an operation by external references triplet (beta)

The API allows to retrieve an operation using its external operation references for the given account by using issuer account external reference or the account reference (generated by WL).

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

Retrieve corporate contract for a card contract by external reference (beta)

The API allows the corporate contract detail of a card contract to be retrieved.

GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract
Retrieve corporate contract for a card contract (beta)

The API allows the contract detail of a corporate card contract to be retrieved.

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

Modify an entity of a Corporate contract (beta)

The API allows certain data of an existing entity of a corporate contract to be updated such as

  • the allowed advertisement channels (flags)
  • the allowed delivery channel for possible letters

As a result the corporate contract entity is immediately updated with provided data in our system.

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

Modify an entity of a Corporate contract by external reference (beta)

The API allows certain data of an existing entity of a corporate contract to be updated such as

  • the allowed advertisement channels (flags)
  • the allowed delivery channel for possible letters

As a result the corporate contract entity is immediately updated with provided data in our system.

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

Retrieve contract owner for a corporate contract (beta)

This API allows the contract owner for a corporate contract identified by the Issuer Contract external reference or the Contract reference, to be retrieved.

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

Retrieve contract owner for a corporate contract by external reference (beta)

This API allows the contract owner for a corporate contract identified by the Issuer Contract external reference or the Contract reference, to be retrieved.

 

What's Changed

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

Request body :

  • Added property documentTypeId (string)
POST /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}/documents

Request body :

  • Added property documentTypeId (string)
POST /issuers/{issuerId}/cards/block-all

Request body :

  • Added property cancelScheduledCardBlocking (boolean)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block

Request body :

  • Added property cancelScheduledCardBlocking (boolean)
POST /issuers/{issuerId}/cards/{cardReference}/block

Request body :

  • Added property cancelScheduledCardBlocking (boolean)
POST /issuers/{issuerId}/operations/{externalOperationReference}/disputes

Request body :

  • Changed property disputeDocuments (array)
    • Changed items (object CreateDocumentRequest)
      • Added property documentTypeId (string)
POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card

Response:

  • Changed property data (object CreateEmergencyCardResponse)
    • Added property maskedPan (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card

Response:

  • Changed property data (object CreateEmergencyCardResponse)
    • Added property maskedPan (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object Account)
    • Added property externalVelocityLimits (array)
    • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}

Response:

  • Changed property data (object Operation)
    • New required properties:
      • status
GET /issuers/{issuerId}/accounts/{accountReference}

Response:

  • Changed property data (object Account)
    • Added property externalVelocityLimits (array)
    • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}

Response:

  • Changed property data (object Operation)
    • New required properties:
      • status
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations

Parameters:

Added: sort in query
Changed: printOnStatement in query

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
GET /issuers/{issuerId}/accounts/{accountReference}/operations

Parameters:

Added: sort in query
Changed: printOnStatement in query

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations

Response:

  • Changed property data (array)
    • Changed items (object Operation)
      • New required properties:
        • status
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace

Request body :

  • Changed property blockCardRequest (object BlockCardRequest)
    • Added property cancelScheduledCardBlocking (boolean)
POST /issuers/{issuerId}/cards/search

Request body :

  • New optional properties:

    • pan
  • Added property panReference (string)

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

Request body :

  • Changed property blockCardRequest (object BlockCardRequest)
    • Added property cancelScheduledCardBlocking (boolean)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/customers/{customerReference}/accounts

Response:

  • Changed property data (array)
    • Changed items (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/accounts/{accountReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

Response:

  • Changed property data (object CorporateEmployeeAccount)
    • Changed property account (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-contract-entity/{companyEntityExternalReference}

OperationId:

modifyCorporateContractEntity -> modifyCorporateContractEntityDeprecated

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

OperationId:

modifyCorporateContractEntityByIssuerExtRef -> modifyCorporateContractEntityByIssuerExtRefDeprecated

POST /search-operations

Response:

  • Changed property data (object ApiResponseEntityListOperation)
    • Changed property data (array)
      • Changed items (object Operation)
        • New required properties:
          • status
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/contracts/{contractReference}

Response:

  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}

Response:

  • Changed property data (object CorporateContract)
    • Changed property rootAccount (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Added property externalVelocityLimits (array)
          • Added property externalAuthorizationsRestrictions (array)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Changed property account (object Account)
          • Added property externalVelocityLimits (array)
          • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}

Response:

  • Changed property data (object CorporateContract)
    • Changed property rootAccount (object Account)
      • Added property externalVelocityLimits (array)
      • Added property externalAuthorizationsRestrictions (array)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Added property externalVelocityLimits (array)
          • Added property externalAuthorizationsRestrictions (array)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Changed property account (object Account)
          • Added property externalVelocityLimits (array)
          • Added property externalAuthorizationsRestrictions (array)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Request body :
  • Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Request body :

  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
        • Response:
        • Changed property data (object AddCardsAccountsResponse)
          • Added property originalContract (object)
          • Added property changedContract (object)
          • Added property productChangeInformation (object)
POST /issuers/{issuerId}/contracts/search

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property externalVelocityLimits (array)
          • Added property externalAuthorizationsRestrictions (array)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

Request body :

  • Changed property accountHierarchy (object AddCardsAccountsRequest.AccountHierarchy)
    • Changed property accounts (array)
      • Changed items (object CreateConsumerContractRequest.Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
        • Response:
        • Changed property data (object AddCardsAccountsResponse)
          • Added property originalContract (object)
          • Added property changedContract (object)
          • Added property productChangeInformation (object)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts

Response:

  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property externalVelocityLimits (array)
          • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property externalVelocityLimits (array)
          • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property rootAccount (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Added property externalVelocityLimits (array)
            • Added property externalAuthorizationsRestrictions (array)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property account (object Account)
            • Added property externalVelocityLimits (array)
            • Added property externalAuthorizationsRestrictions (array)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property rootAccount (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Added property externalVelocityLimits (array)
            • Added property externalAuthorizationsRestrictions (array)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property account (object Account)
            • Added property externalVelocityLimits (array)
            • Added property externalAuthorizationsRestrictions (array)
POST /search-contracts

Response:

  • Changed property data (object ApiResponseEntityListContract)
    • Changed property data (array)
      • Changed items (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Added property externalVelocityLimits (array)
            • Added property externalAuthorizationsRestrictions (array)
POST /search-corporate-contracts

Response:

  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property rootAccount (object Account)
        • Added property externalVelocityLimits (array)
        • Added property externalAuthorizationsRestrictions (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Added property externalVelocityLimits (array)
            • Added property externalAuthorizationsRestrictions (array)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property account (object Account)
            • Added property externalVelocityLimits (array)
            • Added property externalAuthorizationsRestrictions (array)
  •  

What's Deleted

No API deleted.

 

What's Deprecated

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

Modify an entity of a Corporate contract (beta) - deprecated

The API allows certain data of an existing entity of a corporate contract to be updated such as

  • the allowed advertisement channels (flags)
  • the allowed delivery channel for possible letters

As a result the corporate contract entity is immediately updated with provided data in our system.

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

modify an entity of a Corporate contract by external reference (beta) - deprecated

The API allows certain data of an existing entity of a corporate contract to be updated such as

  • the allowed advertisement channels (flags)
  • the allowed delivery channel for possible letters

As a result the corporate contract entity is immediately updated with provided data in our system.

 

Enable "on this page" menu on doc section
On

Data Export

Data Export

API Reference

Data export solution description

The data export solution is a new external Push Service totally independent from the existing scoring notification request, containing a maximum of information of the transaction and the authentication process.

The platform HUB purposes two kinds connectivity with banks for this purpose.

  • The data are sent by Webservice to API REST bank Server end-point

or

  • The data are sent by file to bank file Server

Data export scheme

The data export solution defined is based on data conveyed in the AReq and RReq messages + Scoring and authentication process.

It takes advantage of the HUB to provide the necessary available data from those messages.

The HUB is the key module to collect and to treat those data as it is the central module involved in the 3DS authentication process. 

The messages contain most of the relevant information needed to get the context of a transaction and to provide enough information to consolidate and refine the authorization process.

Workflow of the process:

  • The HUB collect data from Areq and Rreq messages.
  • The datas are encrypted and sent through messages to the transaction export gateway.
  • The data are sent through a specific gateway to the IS bank according to the selected option (batch file or real time).

Real-time push option

With this solution, bank will be able to receive the data just after the authentication transaction ending (after RReq/RRes message).

The data are pushed to bank through a dedicated Webservice API.

The data will be sent on a REST JSON format. The Web Services will be transmitted in HTTPS - TLS 1.2 and will be configured on the Worldline PCI-DSS Proxy as followed:

  • By default on internet with a mandatory mutualized authentication
  • If asked by the bank, on a VPN or LS

A rate limiter is defined (max TPS) on the HUB push platform and must be configured depending on Issuer Bank transaction volume and IS Bank Server capacity.

If the HUB cannot reach the bank Webservice, a retry process is forecasted. This retry flow is ordered by a FIFO rule.

Two kind of errors are defined, some are due to context and triggers a retry attempt, some are due to data or configuration error and will no triggered any retry. Cf. 3.5.1.2

The retention of data is fixed for a 4 days period. During this time laps the transactions are systematically pushed to the bank until the bank module responds.

After 4 days, the transaction and data not transmitted are deleted from the queue.

Batch file option

With this solution, bank will receive the data through a file.

The file will be generated with a frequency of at least 2 files per day (one per site).

A ‘pull’ or ‘push’ process could be implemented to share the files with IS Bank.

A file system solution will allow Worldline to keep the file during 2 weeks. After this period, the files will be deleted.

The data will be sent on a JSON format through the PCI-DSS gateway on sFTP or PESIT SSL. File could be encrypted in GPG or SMIME.

Enable "on this page" menu on doc section
On

Referential WS Client

Referential WS Client

API Reference

Referential WS Client is the standard referential interfaces exposed by the Issuers' Bank.
ACS is therefore client of the Bank Information System.

Thanks to this API ACS can  :

  • get card information from the Bank Information System ;
  • update cards/users/credentials information to the Bank Information System.

 

Enable "on this page" menu on doc section
On