ob-obp-notification-service-duplicate-2

Push Notification

API Reference

The Push Notification APIs described in this chapter need to be implemented on the Initiating Party side, if the Initiating Party decides to use them. The Open Banking Service will post notifications to these endpoints.

POST Status

Endpoint: POST /status

This API will notify the initiating party about the status of the payment. A different request will be sent for the Payment and Data. More details about the fields can be found in the API reference.

Request Payment (PaymentDetailedInformation)

Post status request payment

Response

HTML 204 (No Content)

Post status response

 

Enable "on this page" menu on doc section
On

ob-p-a2a-preauthentication

Pre Authentication

API Reference

This page describes the pre-authentication API which can be used to request pre-authentication of the PSU.

Some ASPSP’s support the pre-authentication of the PSU. This will allow a PSU to authenticate once for a specific TPP after which the pre-authentication can be used in subsequent payments/consents requests by the TPP (The same PsuId should be used in those requests so that the pre-authentication can be connected). Each individual request still needs to be authorized by the PSU, but authentication is not longer needed. This can speed up the flow for these subsequent payments/consents.

The reach directory indicates which ASPSP’s support this functionality, see the ‘Details’ section of the Reach directory response.

The Open Banking Solution will also arrange a pre-authentication as part of the post payments flow, if mandatory. In which case it will be handled ‘behind the screens’. This pre-authentication API is meant for cases in which the TPP want’s to request the pre-authentication before a payment flows starts, so it becomes a stand-alone pre-authentication request.

Another case in which this API should be used is when ‘PreAuthenticationForEmbedded’ is returned by the post payments/consents API. In this case the pre-authentication is required and cannot be handled ‘behind the screens’.

 

Pre Authentication status

A pre-authentication has a status. 

Status name description
Open The pre-authentication resource has been created, but is not yet authorized by the PSU
Pending The status is pending at the ASPSP, make another status request to receive an update.
Rejected The pre-authentication has been rejected, this is a final state
Authorised The pre-authentication has been approved by the PSU. It will be used by the Open Banking Service when a payment or consent flow is initiated with the same PsuId and AspspId. 
Expired The pre-authentication has been expired can no no longer be used, this is a final state
Revoked The pre-authentication has been revoked by the ASPSP, this is a final state.
Error An error occurred, this is a final state

Flow example

The flow below gives an example of a stand-alone pre-authentication request, combined with a payment. Notice that in the payment step authentication is no longer required due to the pre-authentication.

Datamodel

POST pre-authentication

Endpoint: POST /psus/{psuId}/pre-authentication

This API starts the pre-authentication request flow.

Request

Response

PUT pre-authentication

Endpoint: PUT /psus/{psuId}/pre-authentication/{preAuthenticationId}

This API is used to update a pre-authentication resource.

Request

Response

Delete pre-authentication

Endpoint: DELETE /psus/{psuId}/pre-authentication/{preAuthenticationId}

This API is used to delete a pre-authentication resource.

Request

Response

HTML 204 (No Content, success)

Get pre-authentication status

Endpoint: GET /psus/{psuId}/pre-authentication/{preAuthenticationId}/status

This API is used to get the status of a pre-authentication resource.

Request

Response

Enable "on this page" menu on doc section
On

ob-obp-notification-service-duplicate

Push Notification

API Reference

The Push Notification APIs described in this chapter need to be implemented on the Initiating Party side, if the Initiating Party decides to use them. The Open Banking Service will post notifications to these endpoints.

POST Status

Endpoint: POST /status

This API will notify the initiating party about the status of the payment. A different request will be sent for the Payment and Data. More details about the fields can be found in the API reference.

Request Payment (PaymentDetailedInformation)

Post status request payment

Response

HTML 204 (No Content)

Post status response

 

Enable "on this page" menu on doc section
On

ob-p-a2a-status-duplicate

Payment Status

Payments have different status depending on the actual state of processing: 

  • Open

  • Authorised

  • PartiallyAuthorised

  • SettlementIinProcess

  • SettlementCompleted

  • ReceivedByCreditorBank

  • ReceivedOnCreditorAccount

  • Cancelled

  • CancelledAtTPP

  • Error

  • Expired

  • Pending (The Apsps put the payment in a pending state, this can happen for multiple reasons. This is not a final state, another get payments/status should be made to get an update on the status)

Not all ASPSPs are differentiating between all the status values listed above. The Status PartiallyAuthorised can be given for a payment in multi-authorizations if the first PSU has authorised and there are still authorizations of additional PSUs are outstanding. The Multi-Authorization is an extended service of Accout-to-Account payments.

For some ASPSPs the status of a payment isn’t updated furthermore when the Authorised status is achieved. For most ASPSPs the final status is SettlementCompleted. Information on the final status for payments for given ASPSPs can be retrieved form the Reach API.

Open Banking Services

In the following picture the status values are shown in a state diagram:

Activity diagram Payment statuses

Bank Selection Interface

While using the Bank selection interface the following payment status flow is applicable:

Activity diagram Payment Status when using the Worldline Payment GUI

 

GET Payment Status

These endpoints are used to retrieve the status of a payment.

Endpoint: GET /payments/{paymentId}/status

Endpoint: GET /periodic-payments/{paymentId}/status

Endpoint: GET /scheduled-payments/{paymentId}/status

Endpoint: GET /bulk-payments/{paymentId}/status

Request - Get payments/status

Get payments status request

Response - Get payments/status

Get payments status response

Example: Payment status

 

Request

Address: https://localhost:8443/xs2a/routingservice/services/ob/v3/payments/11376380/status

    HttpMethod: GET

    Headers: {Accept=application/json, Digest=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=, 
X-Request-ID=de875f27-5eb7-2b3d-bb88-86e0fe0cdf65, Authorization=Bearer ec464ba833a955952646cbc834f4e6b, MessageCreateDateTime=2022-03-24T14:48:16.143Z}

Response

ResponseCode: 200

    Headers: { X-Request-ID=283c264a-3212-4240-a039-01b229fa854f, MessageCreateDateTime=2022-03-24T14:48:16.541Z}
    Payload: {"CommonPaymentData":
    "PaymentStatus": "SettlementCompleted",
    "PaymentId": "11376380",
    "AspspPaymentId": "00015952769469210",
    "AspspId": "10002"
}}
Enable "on this page" menu on doc section
On

Release Notes: Recent Update

Recent Update

Version 2.16.2 to 2.17.3

What's New

GET /issuers/{issuerId}/transactions/{transactionId}

Retrieve transaction details (beta)

The API retrieves the detail of specific transaction. By passing transaction id, API gives all details of that particular transaction.

What's Changed

GET /issuers
Parameters:

Added: rootIssuer in query

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases/{businessCaseId}

Response:

  • Changed property data (object GetBusinessCaseResponse)
    • Changed property firstAuthorizationIdentifier (object AuthorizationIdentifier)
      • Added property issuerExternalAuthorizationReference (string)

GET /issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases/{businessCaseId}

Response:
  • Changed property data (object GetBusinessCaseResponse)
    • Changed property firstAuthorizationIdentifier (object AuthorizationIdentifier)
      • Added property issuerExternalAuthorizationReference (string) 

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

Response:
  • Changed property data (object Order)
    • Changed property card (object Card)
      • Changed property cardContract (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string) 

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

Response:
  • Changed property data (object Order)
    • Changed property card (object Card)
      • Changed property cardContract (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)

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

Response:
  • New optional properties:

    • data
  • Changed property data (object ModifyCardBlockingInformationResponse)

    • New required properties:
      • cardIdentifier 

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

Response:
  • New optional properties:

    • data
  • Changed property data (object ModifyCardBlockingInformationResponse)

    • New required properties:
      • cardIdentifier

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases

Response:
  • Changed property data (array)
    • Changed items (object BusinessCase)
      • Changed property firstAuthorizationIdentifier (object AuthorizationIdentifier)
        • Added property issuerExternalAuthorizationReference (string) 

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

Response:
  • Changed property data (object GetAuthorizationResponse)
    • Changed property authorizationIdentifier (object AuthorizationIdentifier)
      • Added property issuerExternalAuthorizationReference (string) 

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

Response:
  • Changed property data (object Operation)
    • Changed property pointOfService (object PointOfService)
      • Added property posTerminalCapability (string) 

GET /issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases

Response:
  • Changed property data (array)
    • Changed items (object BusinessCase)
      • Changed property firstAuthorizationIdentifier (object AuthorizationIdentifier)
        • Added property issuerExternalAuthorizationReference (string) 

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

Response:
  • Changed property data (object GetAuthorizationResponse)
    • Changed property authorizationIdentifier (object AuthorizationIdentifier)
      • Added property issuerExternalAuthorizationReference (string) 

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

 

Response:
  • Changed property data (object Operation)
    • Changed property pointOfService (object PointOfService)
      • Added property posTerminalCapability (string)

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

Response:
  • Changed property data (array)
    • Changed items (object BusinessCase)
      • Changed property firstAuthorizationIdentifier (object AuthorizationIdentifier)
        • Added property issuerExternalAuthorizationReference (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object BusinessCase)
      • Changed property firstAuthorizationIdentifier (object AuthorizationIdentifier)
        • Added property issuerExternalAuthorizationReference (string) 

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

Response:
  • Changed property data (object Card)
    • Changed property cardContract (object CardContract)
      • Added property cardTypeLabel (string)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
    • Changed property orders (array)
      • Changed items (object Order)
        • Changed property card (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object Order)
      • Changed property card (object Card)
        • Changed property cardContract (object CardContract)
          • Added property cardTypeLabel (string)
          • Changed property cards (array)
            • Changed items (object Card)
              • Changed property cardContract (object CardContract)
                • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (object Card)
    • Changed property cardContract (object CardContract)
      • Added property cardTypeLabel (string)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
    • Changed property orders (array)
      • Changed items (object Order)
        • Changed property card (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object Order)
      • Changed property card (object Card)
        • Changed property cardContract (object CardContract)
          • Added property cardTypeLabel (string)
          • Changed property cards (array)
            • Changed items (object Card)
              • Changed property cardContract (object CardContract)
                • Added property cardTypeLabel (string)

 POST /search-transactions

Parameters:

Added: filter in query

Request body :
  • Added property transactionAmountCurrency (string)
  • Added property processingDateFrom (string)
  • Added property processingDateTo (string)
  • Added property transactionTypes (array)

Response:

  • Changed property data (array)
    • Changed items (object Transaction)
      • Added property reversed (boolean)
      • Added property authorizationIdentifier (object)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Authorization)
      • Changed property authorizationIdentifier (object AuthorizationIdentifier)
        • Added property issuerExternalAuthorizationReference (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Authorization)
      • Changed property authorizationIdentifier (object AuthorizationIdentifier)
        • Added property issuerExternalAuthorizationReference (string)

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

Response:
  • Changed property data (array)
    • Changed items (object Authorization)
      • Changed property authorizationIdentifier (object AuthorizationIdentifier)
        • Added property issuerExternalAuthorizationReference (string)

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property status (string)
      • Changed property pointOfService (object PointOfService)
        • Added property posTerminalCapability (string) 

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

Response:
  • Changed property data (object CardContract)
    • Added property cardTypeLabel (string)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property cardTypeLabel (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Changed property cardContract (object CardContract)
        • Added property cardTypeLabel (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (object CardContract)
    • Added property cardTypeLabel (string)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property cardTypeLabel (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Changed property cardContract (object CardContract)
        • Added property cardTypeLabel (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string) 

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

Response:
  • Changed property data (object CardContract)
    • Added property cardTypeLabel (string)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property cardTypeLabel (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property cardTypeLabel (string) 

POST /issuers/{issuerId}/cards/search 

Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Changed property cardContract (object CardContract)
        • Added property cardTypeLabel (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (object CardContract)
    • Added property cardTypeLabel (string)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property cardTypeLabel (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property cardTypeLabel (string) 

POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/reallocate

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object CardContract)
      • Added property cardTypeLabel (string)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string) 

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

Request body :
  • Changed property corporateEmployeeAccount (object ModifyCorporateEmployeeAccountRequest.CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property postingAccountForMembershipFee (string)
      Added enum value:
      • ENTITY_ACCOUNT
    • Changed property postingAccountForAccountSetupFee (string)
      Added enum value:
      • ENTITY_ACCOUNT

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

Response:
  • Changed property data (object CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string) 

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

Request body :
  • Changed property corporateEmployeeAccount (object ModifyCorporateEmployeeAccountRequest.CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property postingAccountForMembershipFee (string)
      Added enum value:
      • ENTITY_ACCOUNT
    • Changed property postingAccountForAccountSetupFee (string)
      Added enum value:
      • ENTITY_ACCOUNT

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

Response:
  • Changed property data (object CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string) 

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

Request body :
  • Changed property corporateEmployeeAccount (object ModifyCorporateEmployeeAccountRequest.CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property postingAccountForMembershipFee (string)
      Added enum value:
      • ENTITY_ACCOUNT
    • Changed property postingAccountForAccountSetupFee (string)
      Added enum value:
      • ENTITY_ACCOUNT 

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

Response:
  • Changed property data (object CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

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

Request body :
  • Changed property corporateEmployeeAccount (object ModifyCorporateEmployeeAccountRequest.CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property postingAccountForMembershipFee (string)
      Added enum value:
      • ENTITY_ACCOUNT
    • Changed property postingAccountForAccountSetupFee (string)
      Added enum value:
      • ENTITY_ACCOUNT

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

Response:
  • Changed property data (object CorporateEmployeeAccount)
    • Added property entityIdentifierMembershipFeePosting (object)
    • Added property entityIdentifierAccountSetupFeePosting (object)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object CardContract)
      • Added property cardTypeLabel (string)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object CardContract)
      • Added property cardTypeLabel (string)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object CardContract)
      • Added property cardTypeLabel (string)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object CardContract)
      • Added property cardTypeLabel (string)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (string) 
PATCH /issuers/{issuerId}/corporate-contracts/{contractReference}
Request body :
  • Added property postingEntityLevelForMembershipFee (integer)
  • Added property postingEntityLevelForAccountSetupFee (integer)
  • Changed property postingAccountForMembershipFee (string)
    Added enum value:
    • ENTITY_ACCOUNT
  • Changed property postingAccountForAccountSetupFee (string)
    Added enum value:
    • ENTITY_ACCOUNT
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
  • Changed property data (object CorporateContract)
    • Added property postingEntityLevelForMembershipFee (integer)
    • Added property postingEntityLevelForAccountSetupFee (integer)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Added property entityIdentifierMembershipFeePosting (object)
        • Added property entityIdentifierAccountSetupFeePosting (object)
        • Changed property cardContracts (array)
        • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract

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

Request body :
  • Added property postingEntityLevelForMembershipFee (integer)
  • Added property postingEntityLevelForAccountSetupFee (integer)
  • Changed property postingAccountForMembershipFee (string)
    Added enum value:
    • ENTITY_ACCOUNT
  • Changed property postingAccountForAccountSetupFee (string)
    Added enum value:
    • ENTITY_ACCOUNT

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

Response:
  • Changed property data (object CorporateContract)
    • Added property postingEntityLevelForMembershipFee (integer)
    • Added property postingEntityLevelForAccountSetupFee (integer)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Added property entityIdentifierMembershipFeePosting (object)
        • Added property entityIdentifierAccountSetupFeePosting (object)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)
            • Added property cardTypeLabel (string)
            • Changed property cards (array)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

POST /issuers/{issuerId}/contracts/search

Request body :
  • New optional properties:

    • iban
  • Added property accountIdentifier (object)

  • Added property accountMembershipNumber1 (string)

  • Added property accountMembershipNumber2 (string)

  • Added property partnerExternalReference (string)

  • Added property customerAttributes (object)

  • Added property customerIdentifier (object)

  • Added property cardContractIdentifier (object)

  • Added property cardIdentifier (object)

  • Added property pan (string)

  • Added property retrieveParentAccount (boolean)

  • Added property retrieveParentChildAccounts (boolean)

  • Added property phoneticSearch (boolean)

  • Added property phoneticAlgorithm (array) 

Response:

Changed property data (array)

  • Changed items (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (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)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property cardTypeLabel (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Added property cardTypeLabel (string)
          • Changed property cards (array)
            • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

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

Changed property data (array)

  • Changed items (object CorporateContract)
    • Added property postingEntityLevelForMembershipFee (integer)
    • Added property postingEntityLevelForAccountSetupFee (integer)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Added property entityIdentifierMembershipFeePosting (object)
        • Added property entityIdentifierAccountSetupFeePosting (object)
        • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Added property cardTypeLabel (string)
          • Changed property cards (array)
            • Changed items (object Card)
              • Changed property cardContract (object CardContract)
                • Added property cardTypeLabel (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

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

Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Added property postingEntityLevelForMembershipFee (integer)
      • Added property postingEntityLevelForAccountSetupFee (integer)
      • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Added property entityIdentifierMembershipFeePosting (object)
        • Added property entityIdentifierAccountSetupFeePosting (object)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)
            • Added property cardTypeLabel (string)
            • Changed property cards (array)
              • Changed items (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property cardTypeLabel (string)
                • Changed property orders (array)
                  • Changed items (object Order)
                  • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string)

POST /search-corporate-contracts

Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Added property postingEntityLevelForMembershipFee (integer)
      • Added property postingEntityLevelForAccountSetupFee (integer)
      • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
      • Added property entityIdentifierMembershipFeePosting (object)
      • Added property entityIdentifierAccountSetupFeePosting (object)
      • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property cardTypeLabel (string)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property cardTypeLabel (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property cardTypeLabel (string) 

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

  • Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
        • Added property entityIdentifierMembershipFeePosting (object)
        • Added property entityIdentifierAccountSetupFeePosting (object)

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

Request body :
  • Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
        • Added property entityIdentifierMembershipFeePosting (object)
        • Added property entityIdentifierAccountSetupFeePosting (object)

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

Request body :
  • Changed property corporateContract (object CreateCorporateContractRequest.Contract)
    • Added property postingEntityLevelForMembershipFee (integer)
    • Added property postingEntityLevelForAccountSetupFee (integer)
  • Changed property addCorporateEmployeeCardsAndAccounts (array)
    • Changed items (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
          • Added property entityIdentifierMembershipFeePosting (object)
          • Added property entityIdentifierAccountSetupFeePosting (object)

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string)

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

Request body :
  • Added property vulnerabilities (array)
  • Added property vulnerabilityIndicator (boolean)
  • Added property vulnerabilityNote (string) 

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

Request body :
  • Added property GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}vulnerabilityIndicator (boolean)
  • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (string) 

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

Request body :
  • Added property vulnerabilities (array)
  • Added property vulnerabilityIndicator (boolean)
  • Added property vulnerabilityNote (string)

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

Request body :
  • Added property vulnerabilities (array)
  • Added property vulnerabilityIndicator (boolean)
  • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Customer)
    • Added property vulnerabilities (array)
    • Added property vulnerabilityIndicator (boolean)
    • Added property vulnerabilityNote (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 cardHolder (object ModifyCustomerRequest)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Request body :
  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property cardHolder (object ModifyCustomerRequest)
      • Added property vulnerabilities (array)
      • Added property vulnerabilityIndicator (boolean)
      • Added property vulnerabilityNote (string) 

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

Request body :
  • Changed property replaceCardRequest (object ReplaceCardRequest)
    • Changed property cardContract (object ReplaceCardRequest.CardContract)
      • Changed property cardHolder (object ModifyCustomerRequest)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Request body :
  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property cardHolder (object ModifyCustomerRequest)
      • Added property vulnerabilities (array)
      • Added property vulnerabilityIndicator (boolean)
      • Added property vulnerabilityNote (string) 

GET /issuers/{issuerId}/customers

Response:
  • Changed property data (array)
    • Changed items (object Customer)
      • Added property vulnerabilities (array)
      • Added property vulnerabilityIndicator (boolean)
      • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Contract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object Contract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Contract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string)

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

Response:
  • Changed property data (object CorporateContract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object CorporateContract)
    • Changed property contractCustomers (array)
      • Changed items (object Customer)
        • Added property vulnerabilities (array)
        • Added property vulnerabilityIndicator (boolean)
        • Added property vulnerabilityNote (string) 

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

Request body :
  • Changed property customers (array)
    • Changed items (object CreateConsumerContractRequest.Customer)
      • Added property vulnerabilities (array)
      • Added property vulnerabilityIndicator (boolean)
      • Added property vulnerabilityNote (string)

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

Request body :
  • Changed property customers (array)
    • Changed items (object CreateConsumerContractRequest.Customer)
      • Added property vulnerabilities (array)
      • Added property vulnerabilityIndicator (boolean)
      • Added property vulnerabilityNote (string) 

POST /issuers/{issuerId}/contracts/search

Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)
          • Added property vulnerabilities (array)
          • Added property vulnerabilityIndicator (boolean)
          • Added property vulnerabilityNote (string) 

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

Request body :
  • Changed property customers (array)
    • Changed items (object CreateConsumerContractRequest.Customer)
      • Added property vulnerabilities (array)
      • Added property vulnerabilityIndicator (boolean)
      • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)
          • Added property vulnerabilities (array)
          • Added property vulnerabilityIndicator (boolean)
          • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)
          • Added property vulnerabilities (array)
          • Added property vulnerabilityIndicator (boolean)
          • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)
          • Added property vulnerabilities (array)
          • Added property vulnerabilityIndicator (boolean)
          • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)
          • Added property vulnerabilities (array)
          • Added property vulnerabilityIndicator (boolean)
          • Added property vulnerabilityNote (string)

POST /search-corporate-contracts

Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property contractCustomers (array)
        • Changed items (object Customer)
          • Added property vulnerabilities (array)
          • Added property vulnerabilityIndicator (boolean)
          • Added property vulnerabilityNote (string) 

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

Response:
  • Changed property data (object Order)
    • Changed property card (object Card)
      • Changed property cardContract (object CardContract)
        • Added property authorizationDataValidation (object)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object)

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

Response:
  • Changed property data (object Order)
    • Changed property card (object Card)
      • Changed property cardContract (object CardContract)
        • Added property authorizationDataValidation (object)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object)

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

Response:
  • Changed property data (object Card)
    • Changed property cardContract (object CardContract)
      • Added property authorizationDataValidation (object)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property authorizationDataValidation (object)
    • Changed property orders (array)
      • Changed items (object Order)
        • Changed property card (object Card)
          • Changed property cardContract (object CardContract)
            • Added property authorizationDataValidation (object)

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

Response:
  • Changed property data (array)
    • Changed items (object Order)
      • Changed property card (object Card)
        • Changed property cardContract (object CardContract)
          • Added property authorizationDataValidation (object)
          • Changed property cards (array)
            • Changed items (object Card)
              • Changed property cardContract (object CardContract)
                • Added property authorizationDataValidation (object)

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

Response:
  • Changed property data (object Card)
    • Changed property cardContract (object CardContract)
      • Added property authorizationDataValidation (object)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property authorizationDataValidation (object)
    • Changed property orders (array)
      • Changed items (object Order)
        • Changed property card (object Card)
          • Changed property cardContract (object CardContract)
            • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (array)
    • Changed items (object Order)
      • Changed property card (object Card)
        • Changed property cardContract (object CardContract)
          • Added property authorizationDataValidation (object)
          • Changed property cards (array)
            • Changed items (object Card)
              • Changed property cardContract (object CardContract)
                • Added property authorizationDataValidation (object) 

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

Request body :
  • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (object CardContract)
    • Added property authorizationDataValidation (object)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property authorizationDataValidation (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Changed property cardContract (object CardContract)
        • Added property authorizationDataValidation (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object) 

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

Request body :
  • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (object CardContract)
    • Added property authorizationDataValidation (object)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property authorizationDataValidation (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Changed property cardContract (object CardContract)
        • Added property authorizationDataValidation (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (object CardContract)
    • Added property authorizationDataValidation (object)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property authorizationDataValidation (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property authorizationDataValidation (object)

 POST /issuers/{issuerId}/cards/search

Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Changed property cardContract (object CardContract)
        • Added property authorizationDataValidation (object)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object)

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

Response:
  • Changed property data (object CardContract)
    • Added property authorizationDataValidation (object)
    • Changed property cards (array)
      • Changed items (object Card)
        • Changed property cardContract (object CardContract)
          • Added property authorizationDataValidation (object)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Changed property cardContract (object CardContract)
                • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property authorizationDataValidation (object)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property authorizationDataValidation (object) 

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

Response:
  • Changed property data (object Contract)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Added property authorizationDataValidation (object)
        • Changed property cards (array)
          • Changed items (object Card)
            • Changed property cardContract (object CardContract)
              • Added property authorizationDataValidation (object)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Changed property cardContract (object CardContract)
                    • Added property authorizationDataValidation (object)

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

Response:
  • Changed property data (array)
    • Changed items (object CardContract)
      • Added property authorizationDataValidation (object)
      • Changed property cards (array)
        • Changed items (object Card)
          • Changed property cardContract (object CardContract)
            • Added property authorizationDataValidation (object)
          • Changed property orders (array)
            • Changed items (object Order)
              • Changed property card (object Card)
                • Changed property cardContract (object CardContract)
                  • Added property authorizationDataValidation (object) 

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