REST API V2 - 2.27.0

REST API V2 - 2.27.0

Version 2.26.1 to 2.27.0

What's New

POST /issuers/{issuerId}/businessRefType/{businessRefType}/businessRefValue/{businessRefValue}/event-stores

Post an Event

What's Changed

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

Response:

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

Response:

  • Changed property data (object CreateDocumentResponse)
    • Added property documentTypeId (string)
POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/insurance-contracts/{insurancePackageReference}/insurance-events

Response:

  • Changed property data (object CreateInsuranceEventResponse)
POST /issuers/{issuerId}/accounts/{accountReference}/insurance-contracts/{insurancePackageReference}/insurance-events

Response:

  • Changed property data (object CreateInsuranceEventResponse)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}

Response:

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

Response:

  • Changed property data (object Order)
    • Changed property card (object Card)
      • Added property externalStatus (string)
      • Changed property cardContract (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property externalStatus (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Changed property card (object Card)
            • Added property externalStatus (string)
POST /issuers/{issuerId}/operations/{externalOperationReference}/disputes

Response:

  • Changed property data (object CreateDisputeResponse)
    • Changed property disputeDocuments (array)
      • Changed items (object CreateDocumentResponse)
        • Added property documentTypeId (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

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

Response:

  • Changed property data (object BlockAndReplaceCardResponse)
    • Changed property replaceCardResponse (object ReplaceCardResponse)
      • Changed property card (object ReplaceCardResponse.Card)
        • Added property externalStatus (string)
      • Changed property newRelatedCardList (array)
        • Changed items (object ReplaceCardResponse)
          • Changed property card (object ReplaceCardResponse.Card)
            • Added property externalStatus (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 externalStatus (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Added property externalStatus (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace

Response:

  • Changed property data (object ReplaceCardResponse)
    • Changed property card (object ReplaceCardResponse.Card)
      • Added property externalStatus (string)
    • Changed property newRelatedCardList (array)
      • Changed items (object ReplaceCardResponse)
        • Changed property card (object ReplaceCardResponse.Card)
          • Added property externalStatus (string)
POST /issuers/{issuerId}/cards/search

Response:

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

Response:

  • Changed property data (object BlockAndReplaceCardResponse)
    • Changed property replaceCardResponse (object ReplaceCardResponse)
      • Changed property card (object ReplaceCardResponse.Card)
        • Added property externalStatus (string)
      • Changed property newRelatedCardList (array)
        • Changed items (object ReplaceCardResponse)
          • Changed property card (object ReplaceCardResponse.Card)
            • Added property externalStatus (string)
GET /issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
  • Changed property data (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property externalStatus (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Changed property card (object Card)
              • Added property externalStatus (string)
POST /issuers/{issuerId}/cards/{cardReference}/replace

Response:

  • Changed property data (object ReplaceCardResponse)
    • Changed property card (object ReplaceCardResponse.Card)
      • Added property externalStatus (string)
    • Changed property newRelatedCardList (array)
      • Changed items (object ReplaceCardResponse)
        • Changed property card (object ReplaceCardResponse.Card)
          • Added property externalStatus (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 externalStatus (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Changed property card (object Card)
                  • Added property externalStatus (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/corporate-contract

Response:

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

Response:

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

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 externalStatus (string)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Changed property card (object Card)
                      • Added property externalStatus (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/corporate-contract

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 externalStatus (string)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Changed property card (object Card)
                      • Added property externalStatus (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 externalStatus (string)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Changed property card (object Card)
                      • Added property externalStatus (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 externalStatus (string)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Changed property card (object Card)
                      • Added property externalStatus (string)
POST /search-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 externalStatus (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                    • Added property externalStatus (string)
POST /issuers/{issuerId}/contracts/create-consumer-contract

Response:

  • Changed property data (object CreateConsumerContractResponse)
    • Changed property contract (object CreateConsumerContractResponse.Contract)
      • Changed property cardContracts (array)
        • Changed items (object CreateConsumerContractResponse.CardContract)
          • Changed property card (object CreateConsumerContractResponse.Card)
            • Added property externalStatus (string)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts

Response:

  • Changed property data (object AddCardsAccountsResponse)
    • Changed property contract (object CreateConsumerContractResponse.Contract)
      • Changed property cardContracts (array)
        • Changed items (object CreateConsumerContractResponse.CardContract)
          • Changed property card (object CreateConsumerContractResponse.Card)
            • Added property externalStatus (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 externalStatus (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                    • Added property externalStatus (string)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts

Response:

  • Changed property data (object AddCardsAccountsResponse)
    • Changed property contract (object CreateConsumerContractResponse.Contract)
      • Changed property cardContracts (array)
        • Changed items (object CreateConsumerContractResponse.CardContract)
          • Changed property card (object CreateConsumerContractResponse.Card)
            • Added property externalStatus (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 externalStatus (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                    • Added property externalStatus (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 externalStatus (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Changed property card (object Card)
                    • Added property externalStatus (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 externalStatus (string)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Changed property card (object Card)
                        • Added property externalStatus (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 externalStatus (string)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Changed property card (object Card)
                        • Added property externalStatus (string)
POST /search-corporate-contracts

Parameters:

Changed: embed in query

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

What's Deleted

No API deleted.

Enable "on this page" menu on doc section
On

Sweden

Sweden

Here is the list of banks in Sweden that you can initiate payments or 

retrieve data from using our Open Banking products: 

 

Enable "on this page" menu on doc section
On

Spain

Spain

Here is the list of banks in Spain that you can initiate payments

 or retrieve data from using our Open Banking products: 

Enable "on this page" menu on doc section
On

Slovenia

Slovenia

Here is the list of banks in Slovenia that you can initiate payments

 or retrieve data from using our Open Banking products: 

Enable "on this page" menu on doc section
On
Subscribe to