ob-data-as-consent status

Read more about ob-data-as-consent status

Consent Status

Consent status reflects the current state of the account holder's approval to access their financial data. The consent can be valid for at most 180 days. The Open Banking Service will provide an http 401 response with error code 123 ‘The PSU consent is expired’ if AIS data is requested after the validity of the consent is expired. You should then request a new consent.

In case of multiple consents for the same bank account, Open Banking Services will choose the consent that will be used to retrieve account data, so you do not need to maintain consent selection logic.

Consent status life cycle

Figure: Consent Status when GET consent/status API is called (click on the picture to enlarge).

Below you can find an explanation of each one of the statuses:

Status	Description
Open	This is the initial consent state, for example in case of a redirect scenario, where additional steps to get the consent are required, like redirecting the account holder towards the bank.
Pending	The consent is not yet finalised or rejected. You should call the GET consent status endpoint to get an update.
Rejected	The consent was rejected by account holder or their bank.
PartiallyAuthorised	The consent is due to a multi-level authorisation, some but not all mandated authorisations have been performed yet.
Authorised	Consent was granted, and is active. You can now retrieve the account data.
Expired	The time the consent was active has been expired. You need to obtain a new consent if you wish to access account data.
Revoked	Consent was revoked by account holder or by their bank. You need to obtain a new consent if you wish to access account data.
RevokedAtTpp	Consent was revoked by account holder or by their bank. You need to obtain a new consent if you wish to access account data.
Error	An error occurred. You need to obtain a new consent if you wish to access account data.
Inactive	Indicates that a consent is inactive because it has been replaced by a newer authorized consent (only 1 consent per account holder / bank combination is allowed.

GET Consent Status

Endpoint: GET /psus/{psuId}/consents/{consentId}/status

Base URL: /xs2a/routingservice/services/ob/ais/v3

This endpoint is used to retrieve the status of a consent. Alternatively, you may use Push notifications functionality.

Data model

Request	Response (Click to enlarge)

ob-data-ad-consent authorisation

Read more about ob-data-ad-consent authorisation

Consent Authorisation

API Reference

The authorisation of consents largely depends on the approach chosen by the account holder's bank:

In the standard Redirect approach with an implicit start of authorisation, no further endpoint needs to be called. In this case, the account holder’s browser is redirected to the bank, which will handle all authorisation steps. However, banks might also require an explicit start of authorisation for the Redirect Approach. In that case, the endpoint POST Authorisations must be used.
In the Decoupled approach, the authorisation must be explicitly started as well, and typically, identification of the PSU is required. Therefore, the Post Identification endpoint must be called.
For the Embedded approach, data must be added to the authorisation through multiple requests to the PUT Authorisation endpoint.

POST Identification

Endpoint: POST /psus/{psuId}/consents/{consentId}/identification

Base URL: /xs2a/routingservice/services/ob/ais/v3

This endpoint is used in Decoupled approach to start the authorisation explicitly and identifying the account holder at the bank to enable the Push message to be sent to the user’s device.

The Initiating Party will need to poll for status changes, since the authorisation is done in Decoupled approach and no feedback is provided directly by the ASPSP to the TPP.

Data model

Request	Response

POST Authorisations

Endpoint: POST /psus/{psuId}/consents/{consentId}/authorisations/{authorisationId}

Base URL: /xs2a/routingservice/services/ob/ais/v3

This endpoint is used in 2 approaches

Embedded approach to start the authorisation and provide the required information according the first step of the embedded authorization flow.
Redirect approach to start explicit redirect authorisation. Mostly is being used in case of multi-level authorisation or when required by end user's bank.

Data model

Request	Response (click to enlarge)

PUT Authorisations

Endpoint: PUT /psus/{psuId}/authorisations/{authorisationId}

Base URL: /xs2a/routingservice/services/ob/ais/v3

This endpoint is used in Embedded Approach to provide the required information according to the necessary steps driven by account holder's bank.

Data model

Request	Response (click to enlarge)

ob-data-ad-consent flows

Read more about ob-data-ad-consent flows

Consent Flows

There are 3 main types of consent flows:

1. Redirect

In the Redirect Approach the browser session of the account holder is redirected from your software to the bank. In that case the bank provides all the pages required for Strong Customer Authentication (SCA). Once the authorisation is complete, the account holder is being redirected back to your software.

2. Decoupled

In the Decoupled Approach no redirection takes place. Instead, the bank notifies the account holder that they need to authenticate themselves, for example using mobile banking app. The authentication is executed by the app. Since this approach is asynchronous, you need to check consent status to know when the authentication process has been finished.

3. Embedded

In the Embedded Approach you have to provide all the screens required for the authentication process and fulfil all necessary steps over the API of the Open Banking Service.

Depending on the consent flow you will need to implement a different sequence of API calls. Please check below sequence diagrams to understand each flow.

You can indicate your preferred SCA method by using PreferredScaMethod (Embedded, Decoupled, Redirect) parameter of POST consent endpoint, but there is no guarantee that the bank will actually use it to authenticate the PSU.

For faster integration and better user experience we offer the Bank Selection Interface, it will then always become a redirect flow from you to this interface. This interface can be customised with your branding allowing to choose the account holder's bank and handling the complexity of different PSD2 authorization flows, so that you will be able to focus on your product and leave the boring stuff to us.

The selected flow with which authentication will go through, is being identified by the name of a hyperlink, provided in the response to the POST consent API call.

Redirect Flow

The sequence diagram below is an example of a typical redirect account data flow. Depending on the individual implementation of the bank, the actual flow may differ slightly. The green vertical bars indicates who is responsible for the interaction with the account holder (PSU).

Redirect back to the Initiating Party

Once the account holder finished the interaction with the bank, the session will be redirected back to you. Here, the Open Banking Service appends the Initiating Party Return URL with the Service Name and the consent ID so that the session can be recognised. This enables the Initiating Party to display the correct screen to the PSU.

An example of a return URL is as follows: https://www.example.org/?scope=QUlTOjc1NDQzMTY3
The Initiating Party would need to base64 decode this string : QUlTOjc1NDQzMTY3
The example above results in: {ServiceName}:{paymentId}, i.e. AIS:75443167

Decoupled Flow

Below is a sequence diagram showing a typical decoupled flow. Depending on the individual implementation of the bank, the actual flow may differ slightly. The green vertical bars indicates who is responsible for the interaction with the account holder.

Embedded Flow

Below is a sequence diagram showing a typical embedded flow. Depending on the individual implementation of the bank, the actual flow may differ slightly. The green vertical bars indicates who is responsible for the interaction with the account holder.

Flow steering by links

The table below includes every possible step with the corresponding approach. In the response of each request the named link informs about the next request to be sent according to the actual state in the flow.

Hyperlink Name	Hyperlink URL API	SCA Approach	Description
PreAuthenticationForEmbedded	POST /pre-auth	Embedded	Pre-Authentication is required and will be made with Embedded Approach.
RedirectUrl	Redirect link	Redirect	URL of PSU’s authentication or authorisation on APSPS side, or towards the Initiation Service
RedirectUrl (towards the Bank selection interface)	a Worldline URL, can optionally be white labeled	Redirect	The Worldline provide Bank selection interface will take care of the subsequent authorization flow. In practice this means that from the Initiating Party perspective it will always be a redirect flow.
PostAuthorisationForExplicit	POST /authorisation	Redirect/ Embedded	Mostly is being used when multi-sca should be done with Redirect Approach. Nobody required in the request.
PostIdentificationForDecoupled	POST /identification	Decoupled	Requires PSU’s identification at ASPSP for Decoupled Approach.
PostAuthorisationForEmbedded	POST /authorisation	Embedded	Start of Authentication with PSU’s credentials at ASPSP.
SelectAuthenticationMethod	PUT /authorisation	Embedded	The update of the authorisation resource where selected SCA method should be provided
AuthorizeTransaction	PUT /authorisation	Embedded	The update of the authorisation resource where challenge response (OTP) should be provided.
ConfirmationRequired	POST /confirmation	Redirect/ Embedded/ Decoupled	Confirmation of the transaction after authorisation is being done or being exempted.
PutAuthorisationForEmbedded	PUT /authorisation	Embedded	The update of the authorisation resource with PSU’s credentials, when some other authorisation steps have been done before.

Release Notes: : REST API V2 - 219.0

Read more about Release Notes: : REST API V2 - 219.0

REST API V2 - 2.19.0

Version 2.17.3 to 2.19.0

What's New

`POST` /issuers/{issuerId}/corporate-contracts/{contractReference}/add-virtual-cards-accounts-service

Add Corporate VCA Service cards and accounts to a corporate contract (beta)

This endpoint can be used to create Virtual Card Account (VCA). This is a specific service offered by MCI, VISA and Wordline service (VCE). The VCA is not used to pay transactions, instead a token is requested from MCI, VISA, Worldline service (depends on the Issuer), to fund the transactions.

`POST` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-virtual-cards-accounts-service

Add Corporate VCA Service cards and accounts to a corporate contract by issuer contract external reference (beta)

`POST` /issuers/{issuerId}/contracts/{contractReference}/replace-customer

Replace a customer within a consumer contract (beta)

Replace a customer within a consumer contract

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer

Replace a customer within a consumer contract by external reference (beta)

Replace a customer within a consumer contract by external reference

What's Changed

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

Response:

Changed property data (object Order)
- Changed property card (object Card)
  - Added property partnerExternalCardReference (string)
  - Changed property cardContract (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property partnerExternalCardReference (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (object Order)
- Changed property card (object Card)
  - Added property partnerExternalCardReference (string)
  - Changed property cardContract (object CardContract)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property partnerExternalCardReference (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`GET` /issuers/{issuerId}/disputes/{disputeFolderReference}

Response:

Changed property data (object Dispute)
- Added property transactionCategory (string)

`GET` /issuers/{issuerId}/operations/{externalOperationReference}/dispute

Response:

Changed property data (object Dispute)
- Added property transactionCategory (string)

`GET` /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}

Response:

Changed property data (object Dispute)
- Added property transactionCategory (string)

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

Response:

Changed property data (object Transaction)
- Added property transactionCategory (string)
- Deleted property transactionType (string)

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

Response:

Changed property data (object Operation)
- Added property operationType (string)

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

Response:

Changed property data (object Operation)
- Added property operationType (string)

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

Response:

Changed property data (object Card)
- Added property partnerExternalCardReference (string)
- Changed property cardContract (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property partnerExternalCardReference (string)
- Changed property orders (array)
  - Changed items (object Order)
    - Changed property card (object Card)
      - Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object Order)
  - Changed property card (object Card)
    - Added property partnerExternalCardReference (string)
    - Changed property cardContract (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (object Card)
- Added property partnerExternalCardReference (string)
- Changed property cardContract (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property partnerExternalCardReference (string)
- Changed property orders (array)
  - Changed items (object Order)
    - Changed property card (object Card)
      - Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object Order)
  - Changed property card (object Card)
    - Added property partnerExternalCardReference (string)
    - Changed property cardContract (object CardContract)
      - Changed property cards (array)
        Changed items (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object Dispute)
  - Added property transactionCategory (string)

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

Response:

Changed property data (array)
- Changed items (object Dispute)
  - Added property transactionCategory (string)

`POST` /search-transactions

Response:

Changed property data (array)
- Changed items (object Transaction)
  - Added property transactionCategory (string)
  - Deleted property transactionType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (array)
- Changed items (object Operation)
  - Added property operationType (string)

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

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property partnerExternalCardReference (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property partnerExternalCardReference (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property partnerExternalCardReference (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property partnerExternalCardReference (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property partnerExternalCardReference (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`POST` /issuers/{issuerId}/cards/search

Response:

Changed property data (array)
- Changed items (object Card)
  - Added property partnerExternalCardReference (string)
  - Changed property orders (array)
    - Changed items (object Order)
      - Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (object CardContract)
- Changed property cards (array)
  - Changed items (object Card)
    - Added property partnerExternalCardReference (string)
    - Changed property orders (array)
      - Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property partnerExternalCardReference (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (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)
    - Changed property cards (array)
      - Changed items (object Card)
        Added property partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property partnerExternalCardReference (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property partnerExternalCardReference (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property partnerExternalCardReference (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (array)
- Changed items (object CardContract)
  - Changed property cards (array)
    - Changed items (object Card)
      - Added property partnerExternalCardReference (string)
      - Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

`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 partnerExternalCardReference (string)
        Changed property orders (array)
        Changed items (object Order)
        Changed property card (object Card)
        Added property partnerExternalCardReference (string)

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

Response:

Changed property data (object Statement)
- Added property iban (string)

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

Response:

Changed property data (object Statement)
- Added property iban (string)

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

Response:

Changed property data (object Statement)
- Added property iban (string)

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

Response:

Changed property data (object Statement)
- Added property iban (string)

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

Response:

Changed property data (object Statement)
- Added property iban (string)

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

Response:

Changed property data (object Statement)
- Added property iban (string)

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

Response:

Changed property data (object Transaction)
- Deleted property authorization (string)
- Deleted property schemeFormatMessage (string)

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

Response:

Changed property data (object Account)
- Changed property payingAccountType (string)
  Added enum value:
  - ENTITY_PAYS Removed enum value:
  - INTERMEDIATE_PAYS

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

Response:

Changed property data (array)
- Changed items (object Statement)
  - Added property iban (string)

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

Response:

Changed property data (object Account)
- Changed property payingAccountType (string)
  Added enum value:
  - ENTITY_PAYS Removed enum value:
  - INTERMEDIATE_PAYS

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

Response:

Changed property data (array)
- Changed items (object Statement)
  - Added property iban (string)

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

Response:

Changed property data (object GetReservesResponse)
- Changed property reserves (array)
  - Changed items (object Reserve)
    - Added property businessCaseId (string)
    - Added property txnId (string)
    - Deleted property businessCaseIdentifier (object)
    - Deleted property firstAuthorizationIdentifier (object)

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

Response:

Changed property data (object GetReservesResponse)
- Changed property reserves (array)
  - Changed items (object Reserve)
    - Added property businessCaseId (string)
    - Added property txnId (string)
    - Deleted property businessCaseIdentifier (object)
    - Deleted property firstAuthorizationIdentifier (object)

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Changed property payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Changed property payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Changed property payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

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

Response:

Changed property data (array)
- Changed items (object Account)
  - Changed property payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS

`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 payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS

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

Response:

Changed property data (object CorporateEmployeeAccount)
- Changed property account (object Account)
  - Changed property payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

`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 payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

`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 payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

`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 payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS

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

Request body :

Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)
- Changed property corporateContractEntityAccounts (array)
  - Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
    - Changed property account (object CreateCorporateContractRequest.Account)
      - Added property payingEntityAccountIdentifier (object)
      - Added property payingEntityCompanyExternalReference (string)
      - Added property payingAccountEntityLevel (integer)

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

Request body :

Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)
- Changed property corporateContractEntityAccounts (array)
  - Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
    - Changed property account (object CreateCorporateContractRequest.Account)
      - Added property payingEntityAccountIdentifier (object)
      - Added property payingEntityCompanyExternalReference (string)
      - Added property payingAccountEntityLevel (integer)

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS

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

Response:

Changed property data (object Contract)
- Changed property accounts (array)
  - Changed items (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS

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

esponse:

Changed property data (object CorporateContract)
- Changed property rootAccount (object Account)
  - Changed property payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

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

Response:

Changed property data (object CorporateContract)
- Changed property rootAccount (object Account)
  - Changed property payingAccountType (string)
    Added enum value:
    - ENTITY_PAYS Removed enum value:
    - INTERMEDIATE_PAYS
- Changed property corporateContractEntities (array)
  - Changed items (object CorporateContractEntity)
    - Changed property account (object Account)
      - Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CorporateEmployeeAccount)
    - Changed property account (object Account)
      - Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

`POST` /issuers/{issuerId}/contracts/search

Response:

Changed property data (array)
- Changed items (object Contract)
  - Changed property accounts (array)
    - Changed items (object Account)
      - Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

`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 payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

`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 payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property rootAccount (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

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

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property rootAccount (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

`POST` /search-corporate-contracts

Response:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property rootAccount (object Account)
    - Changed property payingAccountType (string)
      Added enum value:
      - ENTITY_PAYS Removed enum value:
      - INTERMEDIATE_PAYS
  - Changed property corporateContractEntities (array)
    - Changed items (object CorporateContractEntity)
      - Changed property account (object Account)
        Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - Changed property account (object Account)
        Changed property payingAccountType (string)
        Added enum value:
        ENTITY_PAYS Removed enum value:
        INTERMEDIATE_PAYS

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

Request body :

Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
    - Changed property account (object CreateCorporateContractRequest.Account)
      - Added property payingEntityAccountIdentifier (object)
      - Added property payingEntityCompanyExternalReference (string)
      - Added property payingAccountEntityLevel (integer)

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

Request body :

Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
- Changed property corporateEmployeeAccounts (array)
  - Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
    - Changed property account (object CreateCorporateContractRequest.Account)
      - Added property payingEntityAccountIdentifier (object)
      - Added property payingEntityCompanyExternalReference (string)
      - Added property payingAccountEntityLevel (integer)

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

Request body :

Added property addCorporateVcaServiceCardsAndAccounts (array)
Changed property addCorporateContractEntities (array)
- Changed items (object CreateCorporateContractRequest.AddCorporateContractEntity)
  - Changed property corporateContractEntityAccounts (array)
    - Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
      - Changed property account (object CreateCorporateContractRequest.Account)
        Added property payingEntityAccountIdentifier (object)
        Added property payingEntityCompanyExternalReference (string)
        Added property payingAccountEntityLevel (integer)
Changed property corporateContract (object CreateCorporateContractRequest.Contract)
- Changed property corporateContractRootEntity (object CreateCorporateContractRequest.CorporateContractRootEntity)
  - Changed property rootAccount (object CreateCorporateContractRequest.Account)
    - Added property payingEntityAccountIdentifier (object)
    - Added property payingEntityCompanyExternalReference (string)
    - Added property payingAccountEntityLevel (integer)
Changed property addCorporateEmployeeCardsAndAccounts (array)
- Changed items (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
      - Changed property account (object CreateCorporateContractRequest.Account)
        Added property payingEntityAccountIdentifier (object)
        Added property payingEntityCompanyExternalReference (string)
        Added property payingAccountEntityLevel (integer)

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

ob-obp-notification-service-duplicate-2

Read more about 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

Base URL: URL provided by you as part of your onboarding

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.

Data model

Request (click to enlarge)	Response
Displaying PaymentDetailedInformation

ob-p-a2a-preauthentication

Read more about 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.

POST pre-authentication

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

This API starts the pre-authentication request flow.

Data model

Request	Response (click to enlarge)

PUT pre-authentication

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

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

Data model

Request	Response (click to enlarge)

Delete pre-authentication

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

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

Data model

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.

Data model

Request	Response

Pre Authentication

View Documentation

Read more about Pre Authentication

ob-obp-notification-service-duplicate

Read more about ob-obp-notification-service-duplicate

Push Notification

API Reference

POST Status

Endpoint: POST /status

Base URL: URL provided by you as part of your onboarding

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.

Data model

Request (click to enlarge)

Response

Displaying: PaymentDetailedInformation

ob-p-a2a-status-duplicate

Read more about 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:

Bank Selection Interface

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

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

Data model

Request	Response (click to enlarge)

Example

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"
}}

Release Notes: : REST API V2 - 2.17.3

Read more about Release Notes: : REST API V2 - 2.17.3

REST API V2 - 2.17.3

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

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/{cardContractReference}/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}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- 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}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- 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}/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)
    - 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}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}

Response:

Changed property data (object CorporateEmployeeAccount)
- 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}/contracts/external-contracts/{issuerContractExternalReference}

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}/contracts/external-contracts/{issuerContractExternalReference}/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}/contracts/{contractReference}

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}/contracts/{contractReference}/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}/customers/external-customers/{issuerCustomerExternalReference}/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}/customers/{customerReference}/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}/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)
        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}/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)
        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}/contracts/create-consumer-contract

Request body :

Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
- Changed property cardContracts (array)
  - Changed items (object CreateConsumerContractRequest.CardContract)
    - Added property authorizationDataValidation (object)

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

Request body :

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Added property authorizationDataValidation (object)

POST /issuers/{issuerId}/contracts/search

Response:

Changed property data (array)
- Changed items (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)

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

Request body :

Changed property cardContracts (array)
- Changed items (object CreateConsumerContractRequest.CardContract)
  - Added property authorizationDataValidation (object)

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 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}/customers/{customerReference}/contracts

Changed property data (array)
- Changed items (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}/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)
        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}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts

esponse:

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - 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)

POST /search-corporate-contracts

Changed property data (array)
- Changed items (object CorporateContract)
  - Changed property corporateEmployeeAccounts (array)
    - Changed items (object CorporateEmployeeAccount)
      - 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}/reserves

Parameters:

Deleted: filter in query
Deleted: page in query
Deleted: offset in query

Response:

Changed property data (array -> object)

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

Parameters:

Deleted: filter in query
Deleted: page in query
Deleted: offset in query

Response:

Changed property data (array -> object)

What's Deleted

No API deleted.

What's Deprecated

No API deprecated.

Subscribe to

ob-data-as-consent status

Consent Status

Consent status life cycle

GET Consent Status

Data model

ob-data-ad-consent authorisation

Consent Authorisation

POST Identification

Data model

POST Authorisations

Data model

PUT Authorisations

Data model

ob-data-ad-consent flows

Consent Flows

Redirect Flow

Decoupled Flow

Embedded Flow

Flow steering by links

Release Notes: : REST API V2 - 219.0

REST API V2 - 2.19.0

What's New

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

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

POST /issuers/{issuerId}/contracts/{contractReference}/replace-customer

POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer

What's Changed

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

Response:

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

Response:

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

Response:

GET /issuers/{issuerId}/operations/{externalOperationReference}/dispute

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

POST /search-transactions

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

`POST` /issuers/{issuerId}/corporate-contracts/{contractReference}/add-virtual-cards-accounts-service

`POST` /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-virtual-cards-accounts-service

`POST` /issuers/{issuerId}/contracts/{contractReference}/replace-customer

`POST` /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/replace-customer

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

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

`GET` /issuers/{issuerId}/disputes/{disputeFolderReference}

`GET` /issuers/{issuerId}/operations/{externalOperationReference}/dispute

`GET` /issuers/{issuerId}/disputes/external-disputes/{issuerDisputeExternalReference}

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

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

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

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

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

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

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

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

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

`POST` /search-transactions

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

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

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

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

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

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

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

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

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

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

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

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

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

`POST` /issuers/{issuerId}/cards/search

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

`POST` /issuers/{issuerId}/contracts/search

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

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

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

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

`POST` /search-corporate-contracts

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

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

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

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

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

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

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

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