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.

ob-p-a2a-bulk

Read more about ob-p-a2a-bulk

Bulk Payments

The Payment Process "Bulk payment" allows to send multiple payments at once: individual payments are bundled together into one single transaction. The Bulk Payment is used for processing refunds on PIS payments on the Routingservice. Once the refund is requested by the customer and accepted by the Initiating Party, or initialized by the Initiating Party, the IP can directly use the Refund API for Online Refunds to initiate either a single or up to ten payments on the Routing Service (using the Bulk Payment Interface).

Please also check the Refund Section

The base URL for the Payment Initiation Service API is: /xs2a/routingservice/services/ob/pis/v3

POST Bulk Payments

Endpoint: POST /bulk-payments

This endpoint is used by the Initiating Party to set up payment initiation for an ASPSP.

Example

Example of a bulk payment request body.

{
  "PaymentProduct": [
    "PSD2-SCT"
  ],
  "PaymentProductChangeable": false,
  "PsuData": {
    "AspspId": "20210",
    "AspspProductCode": "string",
    "Country": "FR"
  },
  "CommonPaymentData": {
    "PreferredScaMethod": [
      "Redirect"
    ],
    "DebtorInformation": {
      "Name": "Rob Smith",
      "Agent": "EG8BCROZMX8",
      "Account": {
        "SchemeName": "IBAN",
        "Identification": "DE89370400440532013000",
        "Currency": "EUR"
      }
    },
    "ChargeBearer": "DEBT",
    "Payments": [
      {
        "EndToEndId": "ID-0123456789-A",
        "Amount": {
          "Amount": "123.45",
          "Currency": "EUR"
        },
        "CreditorInformation": {
          "Name": "John Smith",
          "Account": {
            "SchemeName": "IBAN",
            "Identification": "DE89370400440532013012",
            "Currency": "EUR"
          },
          "Agent": "UZWHIKRXVHT",
          "UltimateCreditor": "John Media Shop U"
        },
        "RemittanceInformation": "Remittance Information",
        "RemittanceInformationStructured": {
          "Reference": "Remit-23-43-42",
          "ReferenceType": "structured",
          "ReferenceIssuer": "Reference Issuer"
        }
      },
      {
        "EndToEndId": "ID-0123456789-B",
        "Amount": {
          "Amount": "78.56",
          "Currency": "EUR"
        },
        "CreditorInformation": {
          "Name": "Simon Walker",
          "Account": {
            "SchemeName": "IBAN",
            "Identification": "NL98INGB6709624056",
            "Currency": "EUR"
          }
        },
        "RemittanceInformation": "Remittance Information"
      }
    ]
  }
}

ob-p-a2a-periodic

Read more about ob-p-a2a-periodic

Periodic Payment

The base URL for the Payment Initiation Service API is: /xs2a/routingservice/services/ob/pis/v3

POST Periodic Payments

Endpoint: POST /periodic-payments

This endpoint is used by the Initiating Party to set up payment initiation for an ASPSP.

ob-p-a2a-scheduled

Read more about ob-p-a2a-scheduled

Scheduled Payment

The base URL for the Payment Initiation Service API is: /xs2a/routingservice/services/ob/pis/v3

POST Scheduled Payments

Endpoint: POST /scheduled-payments

This endpoint is used by the Initiating Party to set up payment initiation for an ASPSP.

ob-p-a2a-cancellation

Read more about ob-p-a2a-cancellation

Payment Cancellation

These endpoints are used to cancel a payment on behalf of the Payment Service User. Strong Customer Authentication might be required by the ASPSP, the response will indicate which step is required to complete the payment.

DELETE Payments

Endpoint: DELETE /payments/{paymentId}

Endpoint: DELETE /periodic-payments/{paymentId}

Endpoint: DELETE /scheduled-payments/{paymentId}

Endpoint: DELETE /bulk-payments/{paymentId}

Data model

Request

Response (click to enlarge)

If the ASPSP doesn’t require an SCA for the deletion of a payment, the response will be empty with the HTTP code 204 (deleted). If SCA is required the response will be given with HTTP 200, and the following response:

POST Cancellation-Identification

Endpoint: POST /payments/{paymentId}/cancellation-identification

This API is used to start an authorization process explicitly in the Decoupled Approach, where the PSU identification isn’t given in the DELETE payment already.

Data model

Request	Response

POST Cancellation-Authorisations

Endpoint: POST /payments/{paymentId}/cancellation-authorisations

This endpoint is used to start an authorization process explicitly which is required for some ASPSPs. As well it is used in Multi-Authorization scenarios (supported in an extended PIS service) and in Embedded Approach.

Data model

Request	Response (click to enlarge)

PUT Cancellation-Authorisations

Endpoint: PUT /payments/{paymentId}/cancellation-authorisations/{authorisationId}

This endpoint is used in Embedded Approach to provide the required information according to the necessary steps driven by the ASPSP due to the Links section.

Data model

Request	Response (click to enlarge)

ob-p-a2a-additional

Read more about ob-p-a2a-additional

Additional Payment Functions

Additional Payment Services can be provided by the Open Banking Service. The functions are designed to support the complete payment lifecycle.

ob-p-a2a-step4

Read more about ob-p-a2a-step4

Step 4 Payment Execution

Authorised payment will be validated by the bank and executed according to the payment type.

You can learn about payment execution progress either by polling the payment status by yourself or by subscribing to our push notifications. If you choose to subscribe to push notifications, we will continuously check with the bank on payment authorisation and execution progress and proactively notify you of the changes.

ob-p-a2a-confirmation

Read more about ob-p-a2a-confirmation

Payment Confirmation

Endpoint: POST /payments/{paymentId}/confirmation

Endpoint: POST /periodic-payments/{paymentId}/confirmation

Endpoint: POST /scheduled-payments/{paymentId}/confirmation

Endpoint: POST /bulk-payments/{paymentId}/confirmation

This API is used to confirm a payment. Confirmation can be required when the payment is in the 'AUTHORISED' state:

When its required by the ASPSP standard
When a payment fee is involved, in that case the response of the payments status api will provide a link to this api in the 'FeePaymentConfirmationUrl' field.

Data model

Request	Response

ob-p-a2a-authentication

Read more about ob-p-a2a-authentication

Payment Authentication

The authorization of payments depends greatly on the approach chosen by the ASPSP. In the standard Redirect Approach with implicit start of authorization, no further endpoint needs to be called by the Initiating Party. There is a redirection of the PSU’s browser to the ASPSP, which will handle all steps for authorization without involving the Initiating Party.

However, the ASPSP might require an explicit start of authorization for the Redirect Approach as well. In that case, the endpoint POST Authorizations must be used. In the Decoupled Approach, the authorization must also be started explicitly; usually, for that, the identification of the PSU is required. Therefore, the POST Identification endpoint must be called.

For the Embedded Approach, data has to be added to the authorization by multiple requests to the PUT Authorization endpoint.

These endpoints are defined for Scheduled Payments, Periodic Payments and Bulk Payments separately, but the endpoint definition differs only in the path of the endpoint. All other parameters are identical

POST Payment Identification

Endpoint: POST /payments/{paymentId}/identification

Endpoint: POST /periodic-payments/{paymentId}/identification

Endpoint: POST /scheduled-payments/{paymentId}/identification

Endpoint: POST /bulk-payments/{paymentId}/identification

This API is used to start an authorization process explicitly in the Decoupled Approach, where the PSU identification isn’t given in the POST payment already.

Data model

Request	Response

POST Authorisations

Endpoint: POST /payments/{paymentId}/authorisations

Endpoint: POST /periodic-payments/{paymentId}/authorisations

Endpoint: POST /scheduled-payments/{paymentId}/authorisations

Endpoint: POST /bulk-payments/{paymentId}/authorisations

This endpoint is used to explicitly start an authorization process, which is required by some ASPSPs. It is also used in Multi-Authorization scenarios (supported as an extended service) and in the Embedded Approach.

In the Multi-Authorization scenario, this endpoint will have to be used for each individual authorization, since the ASPSP requires an explicit start of authorization for each of the individual authorizations to be carried out by multiple PSUs for the same payment.

Data model

Request	Response (click to enlarge)

PUT Authorisations

Endpoint: PUT /payments/{paymentId}/authorisations/{authorisationId}

Endpoint: PUT /periodic-payments/{paymentId}/authorisations/{authorisationId}

Endpoint: PUT /scheduled-payments/{paymentId}/authorisations/{authorisationId}

Endpoint: PUT /bulk-payments/{paymentId}/authorisations/{authorisationId}

This endpoint is used in the Embedded Approach to provide the required information according to the necessary steps driven by the ASPSP due to the Links section.

Data model

Request	Response (click to enlarge)

ob-p-a2a-status

Read more about ob-p-a2a-status

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

Subscribe to

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}

What's Changed

GET /issuers

Parameters:

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

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Parameters:

Request body :

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Response:

Request body :

Response:

Request body :

Response:

Request body :

Response:

Request body :

Response:

Response:

Response:

Response:

Response:

Response:

Response:

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

Request body :

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

Response:

Request body :

Response:

Request body :

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

Response

Response:

Response:

Response:

Request body :

Request body :

Response:

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

`GET` /issuers

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

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

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

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