Release Notes: : REST API V2 - 2.15.0

REST API V2 - 2.15.0

Version 2.14.0 to 2.15.0

What's New

No new API.

What's Changed

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)

    • New required properties:

      • postingAccountIdentifier

    • Added property disputed (boolean)

    • Added property printOnStatement (boolean)

    • Added property cardAcceptorAddress (string)

    • Added property cardAcceptorStateProvinceRegionCode (string)

    • Added property subOperationIdentifiers (array)

    • Added property correction (boolean)

    • Added property intermediateAmount (object)

    • Added property billingAmount (object)

    • Added property overallExhangeRate (number)

GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)

    • New required properties:

      • postingAccountIdentifier

    • Added property disputed (boolean)

    • Added property printOnStatement (boolean)

    • Added property cardAcceptorAddress (string)

    • Added property cardAcceptorStateProvinceRegionCode (string)

    • Added property subOperationIdentifiers (array)

    • Added property correction (boolean)

    • Added property intermediateAmount (object)

    • Added property billingAmount (object)

    • Added property overallExhangeRate (number)

GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

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

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

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

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

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

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

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

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

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

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

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

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

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

      • New required properties:

        • postingAccountIdentifier

      • Added property disputed (boolean)

      • Added property printOnStatement (boolean)

      • Added property cardAcceptorAddress (string)

      • Added property cardAcceptorStateProvinceRegionCode (string)

      • Added property postingAccountIdentifier (object)

What's Deleted

No API deleted.

 

What's Deprecated

No API deprecated.

Enable "on this page" menu on doc section
On

Mobile Payment Operations

Mobile Payment Operations

Worldline proposes to Issuing banks to apply card digitization through its tokenization services.

Worldline proposes to Issuing banks to apply card digitization through its tokenization services. A “token” is a unique set of digits which replaces the usual card PAN number and lowers the payment card risk of compromise. Those tokens of real cards are shared in a secured way with mobile/wearable devices (smartphones with Apple pay or Samsung Pay solutions, watches for Garmin Pay, etc.) so that the cardholder can use them instead of the original card for proximity NFC payments with their devices. They can also be leveraged for the recurrent “Card-on-File” transactions (e.g. Netflix). Each context (devices, e-commerce merchants, etc.) will use a different token.

Our solution exposes a set of APIs to Issuers use cases.

Mobile Banking token provisioning support:

  • APP-TO-APP AUTHENTICATION – In this use case, the model is used for Mobile banking App as authentication factor, for identification and verification step
  • In App Provisioning – In this use case, Encrypted pass data (for Apple Pay) or payment instrument data (Google wallets) is generated for wallet activation

APP-TO-APP AUTHENTICATION

 

API Name: generate-crypto-otp

In case of App to App Authentication the cardholder is authenticated via the banking app and the issuer is required to generate a ‘Mobile Banking Authentication Code’ which is delivered via the wallet provider to VTS or MDES for final activation of the token. This Api is common to all Token Requestors, and can be requested by non-sensitive field, either on a specific token (TokenReferenceId), or on a specific card. The choice depends on implementation of mobile banking app.

This service lookup locally to retrieve card data, such as PAN and expiry dates, before computing the activation code, according to either VTS – App to App authentication, or MDES – App to App authentication. We assume that on this step, these data are known, as provisioning flow is already initiated, and on ‘step-up’ before activation.

If the request is done by card, this service requests I-TSP decoupling layer to retrieve card data before computing.

Flow diagram (request by token):

Request data

For Token Reference:

   

"URI":"https":{
   "Root Path"
}"/itsp-add/v2/issuers/9999/tokens/DNITHE301733961114298690/generate-crypto-otp 
Payload":{
   "tokenProviderID":"VTS"
}

For Card Reference:

"
URI":"https":{
   "Root Path"
}"/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/generate-crypto-otp 
Payload":{
   "tokenProviderID":"MDES"
}

Response data


{
    "responseMetadata": {
        "correlationId": "QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
        "statusMessage": "OK",
        "statusCode": 200,
        "responseDateTime": "2023-01-18T14:15:40.323Z",
        "timeTakenMs": 12
    },
    "data": {
        "cryptoOTP": "TUJBQUMtMS0xLTdBRjI5MUM5MUYzRUQ0RUY5MkMxRDQ1RUZGMTI3QzFGOUFCQzEyMzQ3RQ=="
    }

In App Provisioning

 

APPLE PUSH PROVISIONING

 

API Name: create-apple-tokenized-card

Background for Push Provisioning:

In case the cards are added via the banking app the issuer needs to generate the Payment Instrument Details to push the tokenization via the xPay wallet. In case of Apple Pay the issuer also has to add activation data for additional security. The Payment Instrument Details mainly contain the card number and the expiration date of the card which needs to be tokenized. The Payment Instrument Detail is pushed via the wallet server of the xPay based on the xPay interface specifications. The xPay wallet server than will forward it to VTS or MDES, and processed usually as a green flow.

Service provided by I-TSP for this purpose create-apple-tokenized-card (specific Apple variant), generates the complete Payment Data Payload for ApplePay, requested with non-sensitive card data. This service requests the Card Management System to retrieve card data, before computing the payload, according to either Visa or Mastercard flavors.

Note that Apple wallet returns Apple Certificate to mobile application. The validity of this certificate has to be controlled by Issuer (AC chain, dates, specific OID, CRL), and public key extracted, for addressing this service. They are duty of Issuer back-end. As I-TSP has no direct contractual agreement with Apple, there is no possibility to have details about format of Certificate data returned by Apple Wallet, as well as having valid test vectors. Nevertheless, Apple In-App Provisioning specification (document under NDA) gives details on this step.

Below a sample Java code to extract Public Key from Apple leaf certificate (X.509v3 / PEM format) before passing it to this I-TSP Api:

  
CertificateFactory certificateFactory = CertificateFactory.getInstance("X.509");
X509Certificate certificate = (X509Certificate) certificateFactory.generateCertificate(new ByteArrayInputStream(certificateBytes));
System.out.println(Base64.toBase64String(certificate.getPublicKey().getEncoded()));

Flow diagram:

Request data


"URI":"https":{
   "Root Path"
}"/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/create-apple-tokenized-card 
Payload":{
   "tokenProviderID":"VTS",
   "nonce":"2E1DF468",
   "nonceSignature":"401FE09091CE8CB9E8846199587E4417AAE9421F7E9BACB993C57A4E806C4F29716E350060769B0616A11164DF25229D56732A0A5BAEA388F284E5DA369BDA8A2510B86622720808FCA797AAAA8B4B2063",
   "applePublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAELj5cz2uasEvnoi8/rM/ec8h+hxVTlKNIFUCKiWyhijdNrGaa879iIPyGN2f0r0dQfFvCIfxKGYdNrzm0B04+uA=="
}

Response data

 
{
   "responseMetadata":{
      "correlationId":"QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
      "statusMessage":"OK",
      "statusCode":200,
      "responseDateTime":"2023-01-18'T'14:15:40.323Z",
      "timeTakenMs":12
   },
   "data":{
      "encryptedPassData":"aFKevI11muy+D1roaD08NuF2HGnIN5LRKDOGC00nTnERWtkR2IzB6jxe55p8mMc10K3GEjhUPIN2/g4D0wYkzk1GMg9z...",
      "activationData":"TUJQQUMtMS1GSy0xLS1UREVBLTgzQjlEOTdCMEEzM0FCRDk5RkQwQkI5NkEwMjM3NTEzNDNCMERDRDA3NTAyNTFFRTk1NTVBMzIzQUE1OTU1QjVGNjU3ODBERTZGNDk4NkI5",
      "ephemeralPublicKey":"BPrz+LFGyvw3WbuveJ7rLOUKYC2S0lJXYVFXSUCjYTiiS/pT64+Wri3gp3QUIMx8W7mx+Iab5TMC2UDRqMknICY="
   }
}

GOOGLE PUSH PROVISIONING

 

VTS Push Provisioning

 

API Name: create-vts-tokenized-card

Background for Push Provisioning:

In case the cards are added via the banking app the issuer needs to generate the Payment Instrument Details to push the tokenization via the xPay wallet. The Payment Instrument Details mainly contain the card number and the expiration date of the card which needs to be tokenized. The Payment Instrument Detail is pushed via the wallet server of the xPay based on the xPay interface specifications. The xPay wallet server than will forward it to VTS or MDES, and processed usually as a green flow.

Service provided by I-TSP for this purpose is create-vts-tokenized-card (generic per Visa specifications).It is used by all non-Apple wallets (for example by Google who calls structure Opaque Payment Data).

The following web service generates the complete Card Provisioning Payload as specified by VTS, requested with non-sensitive card data (issuerCardIdcardReference, that is a Surrogate of the PAN).

This service requests the Card Management System to retrieve card data, before computing the payload, according to Visa “Payment Instrument Details” structure for Push Provisioning.

Flow diagram:

Request data

    
URI: https://{Root Path}/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/create-vts-tokenized-card 
Payload : 
{ 
       "clientWalletAccountID": "Lejk2eFZ0gPe9DOFNDAhfHy3",
"clientWalletProvider": "40010075001",
"clientDeviceId": "rdtZyP8u4O5LkQFRgPAB-sHo",
"clientAppID": "de.issuerbanking.mobil",
"country": "DE"
}

Response data

    {
    "responseMetadata": {
        "correlationId": "QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
        "statusMessage": "OK",
        "statusCode": 200,
        "responseDateTime": "2023-01-18'T'14:15:40.323Z",
        "timeTakenMs": 12
    },
    "data": {
        "paymentInstrumentDetails": "ewoiYWxnIjoiQTI1NkdDTUtXIiwKInR5cCI6IkpPU0UiLAoiaXYiOiJRYVNLdG1qSUpfYnF4OHpzIiwKInRhZyI6IkFweEpuSmJNeTU1OTMzeWZBTFJTY1E9PSIsCiJraWQiOiJOMVdHMThJM1QySDYwOFZHSUZLMjEzUDVKeXdjOFF2WGRUamVBRXR1azdMN0VwZHZ3IiwKImNoYW5uZWxTZWN1cml0eUNvbnRleHQiOiJTSEFSRURfU0VDUkVUIiwKImVuYyI6IkEyNTZHQ00iLAoiaWF0IjoiMTU4NjM1MDkxNCIKfQ.tYYvs2Cdn0qkVNnE5xDAgGkjx-sBQMP7sA-yj1diVL0.1vWxDYGJs5sPqoaa.LzoOgr97kxNUMZfoKdg8L6OsK3HHQvL2dJYRUddqfD-F90LwBNv24Gc5oOfTYuHSjSYqpP82YQcfhPOYexuW7vRWgwxEQo2tT6Vz4n3Zuy5vsT5OFLMSXtMmJpMqqh3ktvZo9D6NCjqzFlIMJFnUpxiX3dUrmUuCq4bGKxoY6C5KLBDhRo4pEyRsjMNugCVSrKTmAW-SnpFmyW8L066a1HfAQoPomMycZ5U26MPPN__x8k57fDycHn8a6BwWm4ssncJP1sHVPxIpmzGkA89g62n_gxIIWkajdA9tA6t9qaokKfL1wqhVvAch-TxhdLTNORhF_UzlZAILmTe3dsDeZlwy8VOzDpih_zo3Jjj5CYbDiR1yOwnjM35pcBByKouKwYTIxlo4L2Pnfk1QaaNjdVAvA4cPMwQSSymG0hUEZfXOjHBJVUyMAlBLZrwcOlkEwV7iQyusKBqT-j0Y9ULTfYoOv5FD_HMf6pNOcVUf5MqMHlONXurje_VaCU1KahR5_F3HB_YCM7Es74DjAtM-UDJ3YHsKX2aNEX5PbCcRophcVlpkgBC1VhUqgYz0Iytq0GkfFepqrGU0hLrk-CrOm9vNRE8.6T00_EU219IJBNreH7rMnQ"
    }
}

MDES Push Provisioning

 

API Name: create-mdes-tokenized-card

Background for Push Provisioning:

In case the cards are added via the banking app the issuer needs to generate the Payment Instrument Details to push the tokenization via the xPay wallet. The Payment Instrument Details mainly contain the card number and the expiration date of the card which needs to be tokenized. The Payment Instrument Detail is pushed via the wallet server of the xPay based on the xPay interface specifications. The xPay wallet server then will forward it to VTS or MDES, and processed.

Service provided by I-TSP for this purpose is create-mdes-tokenized-card. It is used by all non-Apple wallets (for example by Google who calls structure Opaque Payment Data).

The following web service generates the complete Card Provisioning Payload as specified by MDES, requested with non-sensitive card data (issuerCardId, that is a Surrogate of the PAN).

This service requests Card Management system to retrieve card data, before computing the payload, according to Mastercard “Issuer Initiated Digitization Data” structure for Push Provisioning (Funding Account Info + Tokenization Authentication Value).

Flow diagram:

Request data

    URI: https://{Root Path}/itsp-add/v2/issuers/9999/cards/52936061AAAP8026/create-mdes-tokenized-card 
Payload : 
{ 
       "clientWalletProvider": "50120834693"
}

Response data

    
{
   "responseMetadata":{
      "correlationId":"QQI8qq6jIKq5gO78BocFzSSMI9cI2ReD",
      "statusMessage":"OK",
      "statusCode":200,
      "responseDateTime":"2023-01-18'T'14:15:40.323Z",
      "timeTakenMs":12
   },
   "data":{
      "issuerInitiatedDigitizationData":{
         "fundingAccountInfo":{
            "encryptedPayload":{
               "encryptedData":"4545433044323232363739304532433610DE1D1461475BEB6D815F31764DDC20298BD779FBE37EE5AB3CBDA9F9825E1DDE321469537FE461E824AA55BA67BF6A",
               "publicKeyFingerprint":"4c4ead5927f0df8117f178eea9308daa58e27c2b",
               "encryptedKey":"A1B2C3D4E5F6112233445566",
               "oaepHashingAlgorithm":"SHA512",
               "iv":"31323334353637383930313233343536"
            }
         },
         "tokenizationAuthenticationValue":"\"ew0KICAgInZlcnNpb24iOiAiMyIsDQogICAic2lnbmF0dXJlQWxnb3JpdGhtIjogIlJTQS1TSEEyNTYiLA...”
         }
    }
}"
Enable "on this page" menu on doc section
On

Release Notes: : REST API V2 - 2.14.0

REST API V2 - 2.14.0

Version 2.13.2 to 2.14.0

What's New

POST /search-transactions

Search transactions (beta)

This API allows to search transaction

What's Changed

POST /issuers/{issuerId}/cards/declare-counterfeit-card
Request body :

  • New optional properties:

    • ccpFlag

  • Added property fraudProcess (string)

POST /issuers/{issuerId}/credit-transfers/{endToEndId}/cancel
Response:
  • Changed property data (object CancelCreditTransferResponse)
    • New required properties:
      • cancellationDate
POST /issuers/{issuerId}/direct-debits/{endToEndId}/cancel
Response:
  • Changed property data (object CancelDirectDebitResponse)
    • New required properties:
      • cancellationDate
POST /issuers/{issuerId}/cards/block-all
Request body :
  • Added property fraudProcess (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block
Request body :
  • Added property fraudProcess (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders/{orderReference}
Response:
  • Changed property data (object Order)
    • Added property waitingPin (boolean)
    • Changed property card (object Card)
      • Added property cardDeactivationRuleOverride (string)
      • Changed property statusHistory (array)
        • Changed items (object CardStatusHistory)
          • Changed property blockingInformation (object CardBlockingInformation)
            • Added property fraudProcess (string)
      • Changed property cardContract (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Added property waitingPin (boolean)
          • Changed property card (object Card)
            • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/cards/{cardReference}/block
Request body :
  • Added property fraudProcess (string)
GET /issuers/{issuerId}/cards/{cardReference}/orders/{orderReference}
Response:
  • Changed property data (object Order)
    • Added property waitingPin (boolean)
    • Changed property card (object Card)
      • Added property cardDeactivationRuleOverride (string)
      • Changed property statusHistory (array)
        • Changed items (object CardStatusHistory)
          • Changed property blockingInformation (object CardBlockingInformation)
            • Added property fraudProcess (string)
      • Changed property cardContract (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Added property waitingPin (boolean)
          • Changed property card (object Card)
            • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/cards/{cardReference}/blocking-information
Response:
  • Changed property data (object CardBlockingInformation)
    • Added property fraudProcess (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/blocking-information
Response:
  • Changed property data (object CardBlockingInformation)
    • Added property fraudProcess (string)
PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Request body :
  • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object Account)
    • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)
    • Added property transactionType (string)
    • Changed property pointOfService (object PointOfService)
      • Added property cardDataInputCapability (string)
      • Added property cardholderAuthenticationCapability (string)
      • Added property cardCaptureCapability (string)
      • Added property terminalOperatingEnvironment (string)
      • Added property cardholderPresentData (string)
      • Added property cardPresentData (string)
      • Added property cardDataInputMode (string)
      • Added property cardholderAuthenticationMethod (string)
      • Added property cardholderAuthenticationEntity (string)
      • Added property cardDataOutputCapability (string)
      • Added property terminalDataOutputCapability (string)
      • Added property pinCaptureCapability (string)
PATCH /issuers/{issuerId}/accounts/{accountReference}
Request body :
  • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/accounts/{accountReference}
Response:
  • Changed property data (object Account)
    • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
Response:
  • Changed property data (object Operation)
    • Added property transactionType (string)
    • Changed property pointOfService (object PointOfService)
      • Added property cardDataInputCapability (string)
      • Added property cardholderAuthenticationCapability (string)
      • Added property cardCaptureCapability (string)
      • Added property terminalOperatingEnvironment (string)
      • Added property cardholderPresentData (string)
      • Added property cardPresentData (string)
      • Added property cardDataInputMode (string)
      • Added property cardholderAuthenticationMethod (string)
      • Added property cardholderAuthenticationEntity (string)
      • Added property cardDataOutputCapability (string)
      • Added property terminalDataOutputCapability (string)
      • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}
Response:
  • Changed property data (object Card)
    • Added property cardDeactivationRuleOverride (string)
    • Changed property statusHistory (array)
      • Changed items (object CardStatusHistory)
        • Changed property blockingInformation (object CardBlockingInformation)
          • Added property fraudProcess (string)
    • Changed property cardContract (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property cardDeactivationRuleOverride (string)
    • Changed property orders (array)
      • Changed items (object Order)
        • Added property waitingPin (boolean)
        • Changed property card (object Card)
          • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/card-events
Response:
  • Changed property data (array)
    • Changed items (object CardEvent)
      • Changed property blockingInformation (object CardBlockingInformation)
        • Added property fraudProcess (string)
GET /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/orders
Response:
  • Changed property data (array)
    • Changed items (object Order)
      • Added property waitingPin (boolean)
      • Changed property card (object Card)
        • Added property cardDeactivationRuleOverride (string)
        • Changed property statusHistory (array)
          • Changed items (object CardStatusHistory)
            • Changed property blockingInformation (object CardBlockingInformation)
              • Added property fraudProcess (string)
        • Changed property cardContract (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/cards/{cardReference}
Response:
  • Changed property data (object Card)
    • Added property cardDeactivationRuleOverride (string)
    • Changed property statusHistory (array)
      • Changed items (object CardStatusHistory)
        • Changed property blockingInformation (object CardBlockingInformation)
          • Added property fraudProcess (string)
    • Changed property cardContract (object CardContract)
      • Changed property cards (array)
        • Changed items (object Card)
          • Added property cardDeactivationRuleOverride (string)
    • Changed property orders (array)
      • Changed items (object Order)
        • Added property waitingPin (boolean)
        • Changed property card (object Card)
          • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/cards/{cardReference}/card-events
Response:
  • Changed property data (array)
    • Changed items (object CardEvent)
      • Changed property blockingInformation (object CardBlockingInformation)
        • Added property fraudProcess (string)
GET /issuers/{issuerId}/cards/{cardReference}/orders
Response:
  • Changed property data (array)
    • Changed items (object Order)
      • Added property waitingPin (boolean)
      • Changed property card (object Card)
        • Added property cardDeactivationRuleOverride (string)
        • Changed property statusHistory (array)
          • Changed items (object CardStatusHistory)
            • Changed property blockingInformation (object CardBlockingInformation)
              • Added property fraudProcess (string)
        • Changed property cardContract (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/accounts/{accountReference}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (string)
GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
Response:
  • Changed property data (array)
    • Changed items (object Operation)
      • Added property transactionType (string)
      • Changed property pointOfService (object PointOfService)
        • Added property cardDataInputCapability (string)
        • Added property cardholderAuthenticationCapability (string)
        • Added property cardCaptureCapability (string)
        • Added property terminalOperatingEnvironment (string)
        • Added property cardholderPresentData (string)
        • Added property cardPresentData (string)
        • Added property cardDataInputMode (string)
        • Added property cardholderAuthenticationMethod (string)
        • Added property cardholderAuthenticationEntity (string)
        • Added property cardDataOutputCapability (string)
        • Added property terminalDataOutputCapability (string)
        • Added property pinCaptureCapability (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 cardDeactivationRuleOverride (string)
        • Changed property statusHistory (array)
          • Changed items (object CardStatusHistory)
            • Changed property blockingInformation (object CardBlockingInformation)
              • Added property fraudProcess (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Added property waitingPin (boolean)
            • Changed property card (object Card)
              • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cards
Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Added property cardDeactivationRuleOverride (string)
      • Changed property statusHistory (array)
        • Changed items (object CardStatusHistory)
          • Changed property blockingInformation (object CardBlockingInformation)
            • Added property fraudProcess (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Added property waitingPin (boolean)
          • Changed property card (object Card)
            • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}
Response:
  • Changed property data (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property cardDeactivationRuleOverride (string)
        • Changed property statusHistory (array)
          • Changed items (object CardStatusHistory)
            • Changed property blockingInformation (object CardBlockingInformation)
              • Added property fraudProcess (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Added property waitingPin (boolean)
            • Changed property card (object Card)
              • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cards
Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Added property cardDeactivationRuleOverride (string)
      • Changed property statusHistory (array)
        • Changed items (object CardStatusHistory)
          • Changed property blockingInformation (object CardBlockingInformation)
            • Added property fraudProcess (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Added property waitingPin (boolean)
          • Changed property card (object Card)
            • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/block-and-replace
Request body :
  • Changed property blockCardRequest (object BlockCardRequest)
    • Added property fraudProcess (string)
  • Changed property replaceCardRequest (object ReplaceCardRequest)
    • Changed property cardContract (object ReplaceCardRequest.CardContract)
      • Changed property card (object ReplaceCardRequest.CardContract.Card)
        • Added property cardDeactivationRuleOverride (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 cardDeactivationRuleOverride (string)
        • Changed property statusHistory (array)
          • Changed items (object CardStatusHistory)
            • Changed property blockingInformation (object CardBlockingInformation)
              • Added property fraudProcess (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Added property waitingPin (boolean)
            • Changed property card (object Card)
              • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/replace
Request body :
  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property card (object ReplaceCardRequest.CardContract.Card)
      • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/cards/search
Response:
  • Changed property data (array)
    • Changed items (object Card)
      • Added property cardDeactivationRuleOverride (string)
      • Changed property statusHistory (array)
        • Changed items (object CardStatusHistory)
          • Changed property blockingInformation (object CardBlockingInformation)
            • Added property fraudProcess (string)
      • Changed property orders (array)
        • Changed items (object Order)
          • Added property waitingPin (boolean)
          • Changed property card (object Card)
            • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/cards/{cardReference}/block-and-replace
Request body :
  • Changed property blockCardRequest (object BlockCardRequest)
    • Added property fraudProcess (string)
  • Changed property replaceCardRequest (object ReplaceCardRequest)
    • Changed property cardContract (object ReplaceCardRequest.CardContract)
      • Changed property card (object ReplaceCardRequest.CardContract.Card)
        • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/cards/{cardReference}/card-contract
Response:
  • Changed property data (object CardContract)
    • Changed property cards (array)
      • Changed items (object Card)
        • Added property cardDeactivationRuleOverride (string)
        • Changed property statusHistory (array)
          • Changed items (object CardStatusHistory)
            • Changed property blockingInformation (object CardBlockingInformation)
              • Added property fraudProcess (string)
        • Changed property orders (array)
          • Changed items (object Order)
            • Added property waitingPin (boolean)
            • Changed property card (object Card)
              • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/cards/{cardReference}/replace
Request body :
  • Changed property cardContract (object ReplaceCardRequest.CardContract)
    • Changed property card (object ReplaceCardRequest.CardContract.Card)
      • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/contracts/{contractReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/customers/{customerReference}/accounts
Response:
  • Changed property data (array)
    • Changed items (object Account)
      • Added property hierarchySelectedModels (array)
GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/accounts/{accountReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
Response:
  • Changed property data (object CorporateEmployeeAccountResponse)
    • Changed property account (object Account)
      • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (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 cardDeactivationRuleOverride (string)
          • Changed property statusHistory (array)
            • Changed items (object CardStatusHistory)
              • Changed property blockingInformation (object CardBlockingInformation)
                • Added property fraudProcess (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Added property waitingPin (boolean)
              • Changed property card (object Card)
                • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/contracts/{contractReference}
Response:
  • Changed property data (object Contract)
    • Changed property accounts (array)
      • Changed items (object Account)
        • Added property hierarchySelectedModels (array)
    • Changed property cardContracts (array)
      • Changed items (object CardContract)
        • Changed property cards (array)
          • Changed items (object Card)
            • Added property cardDeactivationRuleOverride (string)
            • Changed property statusHistory (array)
              • Changed items (object CardStatusHistory)
                • Changed property blockingInformation (object CardBlockingInformation)
                  • Added property fraudProcess (string)
            • Changed property orders (array)
              • Changed items (object Order)
                • Added property waitingPin (boolean)
                • Changed property card (object Card)
                  • Added property cardDeactivationRuleOverride (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 cardDeactivationRuleOverride (string)
          • Changed property statusHistory (array)
            • Changed items (object CardStatusHistory)
              • Changed property blockingInformation (object CardBlockingInformation)
                • Added property fraudProcess (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Added property waitingPin (boolean)
              • Changed property card (object Card)
                • Added property cardDeactivationRuleOverride (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 cardDeactivationRuleOverride (string)
          • Changed property statusHistory (array)
            • Changed items (object CardStatusHistory)
              • Changed property blockingInformation (object CardBlockingInformation)
                • Added property fraudProcess (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Added property waitingPin (boolean)
              • Changed property card (object Card)
                • Added property cardDeactivationRuleOverride (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 cardDeactivationRuleOverride (string)
          • Changed property statusHistory (array)
            • Changed items (object CardStatusHistory)
              • Changed property blockingInformation (object CardBlockingInformation)
                • Added property fraudProcess (string)
          • Changed property orders (array)
            • Changed items (object Order)
              • Added property waitingPin (boolean)
              • Changed property card (object Card)
                • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/corporate-contracts/{contractReference}
Response:
  • Changed property data (object CorporateContract)
    • Changed property rootAccount (object Account)
      • Added property hierarchySelectedModels (array)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Added property hierarchySelectedModels (array)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Changed property account (object Account)
          • Added property hierarchySelectedModels (array)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)
            • Changed property cards (array)
              • Changed items (object Card)
                • Added property cardDeactivationRuleOverride (string)
                • Changed property statusHistory (array)
                  • Changed items (object CardStatusHistory)
                    • Changed property blockingInformation (object CardBlockingInformation)
                      • Added property fraudProcess (string)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Added property waitingPin (boolean)
                    • Changed property card (object Card)
                      • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
Response:
  • Changed property data (object CorporateContract)
    • Changed property rootAccount (object Account)
      • Added property hierarchySelectedModels (array)
    • Changed property corporateContractEntities (array)
      • Changed items (object CorporateContractEntity)
        • Changed property account (object Account)
          • Added property hierarchySelectedModels (array)
    • Changed property corporateEmployeeAccounts (array)
      • Changed items (object CorporateEmployeeAccount)
        • Changed property account (object Account)
          • Added property hierarchySelectedModels (array)
        • Changed property cardContracts (array)
          • Changed items (object CardContract)
            • Changed property cards (array)
              • Changed items (object Card)
                • Added property cardDeactivationRuleOverride (string)
                • Changed property statusHistory (array)
                  • Changed items (object CardStatusHistory)
                    • Changed property blockingInformation (object CardBlockingInformation)
                      • Added property fraudProcess (string)
                • Changed property orders (array)
                  • Changed items (object Order)
                    • Added property waitingPin (boolean)
                    • Changed property card (object Card)
                      • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/contracts/create-consumer-contract
Request body :
  • Changed property contract (object CreateConsumerContractRequest.Contract)
    • Changed property accountHierarchy (object CreateConsumerContractRequest.AccountHierarchy)
      • Added property hierarchySelectedModels (array)
  • Changed property addCardsAccounts (object CreateConsumerContractRequest.AddCardsAccounts)
    • Changed property cardContracts (array)
      • Changed items (object CreateConsumerContractRequest.CardContract)
        • Added property selectedModels (array)
POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/add-cards-accounts
Request body :
  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)
      • Added property selectedModels (array)
POST /issuers/{issuerId}/contracts/search
Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property hierarchySelectedModels (array)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property cardDeactivationRuleOverride (string)
              • Changed property statusHistory (array)
                • Changed items (object CardStatusHistory)
                  • Changed property blockingInformation (object CardBlockingInformation)
                    • Added property fraudProcess (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Added property waitingPin (boolean)
                  • Changed property card (object Card)
                    • Added property cardDeactivationRuleOverride (string)
POST /issuers/{issuerId}/contracts/{contractReference}/add-cards-accounts
Request body :
  • Changed property cardContracts (array)
    • Changed items (object CreateConsumerContractRequest.CardContract)
      • Added property selectedModels (array)
GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property hierarchySelectedModels (array)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property cardDeactivationRuleOverride (string)
              • Changed property statusHistory (array)
                • Changed items (object CardStatusHistory)
                  • Changed property blockingInformation (object CardBlockingInformation)
                    • Added property fraudProcess (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Added property waitingPin (boolean)
                  • Changed property card (object Card)
                    • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/customers/{customerReference}/contracts
Response:
  • Changed property data (array)
    • Changed items (object Contract)
      • Changed property accounts (array)
        • Changed items (object Account)
          • Added property hierarchySelectedModels (array)
      • Changed property cardContracts (array)
        • Changed items (object CardContract)
          • Changed property cards (array)
            • Changed items (object Card)
              • Added property cardDeactivationRuleOverride (string)
              • Changed property statusHistory (array)
                • Changed items (object CardStatusHistory)
                  • Changed property blockingInformation (object CardBlockingInformation)
                    • Added property fraudProcess (string)
              • Changed property orders (array)
                • Changed items (object Order)
                  • Added property waitingPin (boolean)
                  • Changed property card (object Card)
                    • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property rootAccount (object Account)
        • Added property hierarchySelectedModels (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Added property hierarchySelectedModels (array)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property account (object Account)
            • Added property hierarchySelectedModels (array)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)
              • Changed property cards (array)
                • Changed items (object Card)
                  • Added property cardDeactivationRuleOverride (string)
                  • Changed property statusHistory (array)
                    • Changed items (object CardStatusHistory)
                      • Changed property blockingInformation (object CardBlockingInformation)
                        • Added property fraudProcess (string)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Added property waitingPin (boolean)
                      • Changed property card (object Card)
                        • Added property cardDeactivationRuleOverride (string)
GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property rootAccount (object Account)
        • Added property hierarchySelectedModels (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Added property hierarchySelectedModels (array)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property account (object Account)
            • Added property hierarchySelectedModels (array)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)
              • Changed property cards (array)
                • Changed items (object Card)
                  • Added property cardDeactivationRuleOverride (string)
                  • Changed property statusHistory (array)
                    • Changed items (object CardStatusHistory)
                      • Changed property blockingInformation (object CardBlockingInformation)
                        • Added property fraudProcess (string)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Added property waitingPin (boolean)
                      • Changed property card (object Card)
                        • Added property cardDeactivationRuleOverride (string)
POST /search-corporate-contracts
Response:
  • Changed property data (array)
    • Changed items (object CorporateContract)
      • Changed property rootAccount (object Account)
        • Added property hierarchySelectedModels (array)
      • Changed property corporateContractEntities (array)
        • Changed items (object CorporateContractEntity)
          • Changed property account (object Account)
            • Added property hierarchySelectedModels (array)
      • Changed property corporateEmployeeAccounts (array)
        • Changed items (object CorporateEmployeeAccount)
          • Changed property account (object Account)
            • Added property hierarchySelectedModels (array)
          • Changed property cardContracts (array)
            • Changed items (object CardContract)
              • Changed property cards (array)
                • Changed items (object Card)
                  • Added property cardDeactivationRuleOverride (string)
                  • Changed property statusHistory (array)
                    • Changed items (object CardStatusHistory)
                      • Changed property blockingInformation (object CardBlockingInformation)
                        • Added property fraudProcess (string)
                  • Changed property orders (array)
                    • Changed items (object Order)
                      • Added property waitingPin (boolean)
                      • Changed property card (object Card)
                        • Added property cardDeactivationRuleOverride (string)

 

      What's Deleted

      No API deleted.

      What's Deprecated

      No API deprecated.

      Enable "on this page" menu on doc section
      On

      Release Notes: : REST API V2 - 2.13.2

      REST API V2 - 2.13.2

      Version 2.13.1 to 2.13.2

      What's New

       

      API Reference
      GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions

      List add-on services subscriptions for a corporate contract by external reference (beta)

      Get addon service information by issuer contract external reference

       

      POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions

      Subscribe to add-on for a corporate contract by external reference (beta)

      Subscribe addon by issuer contract external reference

       

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

      List add-on services subscriptions for a corporate contract (beta)

      Get addon service information by contract reference

       

      POST /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions

      Subscribe to add-on for a corporate contract (beta)

      Subscribe addon by contract reference

       

      POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/addon-subscriptions/unsubscribe

      Unsubscribe add-on for a corporate contract by external reference (beta)

      Unsubscribe addon by issuer contract external reference

       

      POST /issuers/{issuerId}/corporate-contracts/{contractReference}/addon-subscriptions/unsubscribe

      Unsubscribe add-on for a corporate contract (beta)

      Unsubscribe addon by contract reference

       

      What's Changed

       

      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases/{businessCaseId}
      Response:
      • Changed property data (object GetBusinessCaseResponse)
        • Added property status (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases/{businessCaseId}
      Response:
      • Changed property data (object GetBusinessCaseResponse)
        • Added property status (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/authorization-business-cases
      Response:
      • Changed property data (array)
        • Changed items (object BusinessCase)
          • Added property status (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/authorization-business-cases
      Response:
      • Changed property data (array)
        • Changed items (object BusinessCase)
          • Added property status (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/reserves
      Response:
      • Changed property data (array)
        • Changed items (object BusinessCase)
          • Added property status (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/reserves
      Response:
      • Changed property data (array)
        • Changed items (object BusinessCase)
          • Added property status (string)
      POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity
      Request body :
      • Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)
        • Changed property corporateContractEntityAccounts (array)
          • Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
            • Changed property account (object CreateCorporateContractRequest.Account)
              • Added property corporateContractAddOnsSubscriptions (array)
      POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity
      Request body :
      • Changed property addCorporateContractEntity (object CreateCorporateContractRequest.AddCorporateContractEntity)
        • Changed property corporateContractEntityAccounts (array)
          • Changed items (object CreateCorporateContractRequest.CorporateContractEntityAccount)
            • Changed property account (object CreateCorporateContractRequest.Account)
              • Added property corporateContractAddOnsSubscriptions (array)
      POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts
      Request body :
      • Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
        • Changed property corporateEmployeeAccounts (array)
          • Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
            • Changed property account (object CreateCorporateContractRequest.Account)
              • Added property corporateContractAddOnsSubscriptions (array)
        • Changed property corporateEmployeeCards (array)
          • Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
            • Changed property cardContract (object CreateCorporateContractRequest.CardContract)
              • Added property corporateContractAddOnsSubscriptions (array)
      POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts
      Request body :
      • Changed property addCorporateEmployeeCardsAndAccounts (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
        • Changed property corporateEmployeeAccounts (array)
          • Changed items (object CreateCorporateContractRequest.CorporateEmployeeAccount)
            • Changed property account (object CreateCorporateContractRequest.Account)
              • Added property corporateContractAddOnsSubscriptions (array)
        • Changed property corporateEmployeeCards (array)
          • Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
            • Changed property cardContract (object CreateCorporateContractRequest.CardContract)
              • Added property corporateContractAddOnsSubscriptions (array)
      POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract
      Request body :
      • Changed property corporateContract (object CreateCorporateContractRequest.Contract)
        • Changed property corporateContractRootEntity (object CreateCorporateContractRequest.CorporateContractRootEntity)
          • Changed property rootAccount (object CreateCorporateContractRequest.Account)
            • Added property corporateContractAddOnsSubscriptions (array)
      • Changed property addCorporateEmployeeCardsAndAccounts (array)
        • Changed items (object CreateCorporateContractRequest.AddCorporateEmployeeCardsAndAccounts)
          • Changed property corporateEmployeeCards (array)
            • Changed items (object CreateCorporateContractRequest.CorporateEmployeeCard)
              • Changed property cardContract (object CreateCorporateContractRequest.CardContract)
                • Added property corporateContractAddOnsSubscriptions (array)

      What's Deleted

      No API deleted.

      What's Deprecated

      No API deprecated.

      Enable "on this page" menu on doc section
      On

      Release Notes: : REST API V2 - 2.13.1

      REST API V2 - 2.13.1

      Version 2.13.0 to 2.13.1

      What's New

       

      API Reference
      POST /issuers/{issuerId}/contracts/{contractReference}/refund-fee-on-demand

      Refund fee by contract reference (beta)

      The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

      What's Changed

      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-guarantor
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-owner
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/account-guarantor
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/account-owner
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/companies/{customerReference}
      Response:
      • Changed property data (object Company)
        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}
      Response:
      • Changed property data (object Company)
        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/companies/{customerReference}/addresses/{addressReference}
      Response:
      • Changed property data (object Company)
        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/companies/{customerReference}/addresses/external-addresses/{issuerAddressExternalReference}
      Response:
      • Changed property data (object Company)
        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/{addressReference}
      Response:
      • Changed property data (object Company)
        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/addresses/external-addresses/{issuerAddressExternalReference}
      Response:
      • Changed property data (object Company)
        • Added property preferredCorrespondenceLanguage (string)
        • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/cardholder
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/card-contracts/{cardContractReference}/cardholder
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/contract-owner
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/contracts/{contractReference}/contract-owner
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/customers/{customerReference}
      Response:
      • Changed property data (object Customer)
        • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/companies
      Response:
      • Changed property data (array)
        • Changed items (object Company)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/customers
      Response:
      • Changed property data (array)
        • Changed items (object Customer)
          • Added property preferredCorrespondenceLanguage (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 preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/contract
      Response:
      • Changed property data (object Contract)
        • Changed property contractCustomers (array)
          • Changed items (object Customer)
            • Added property preferredCorrespondenceLanguage (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 preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
      Response:
      • Changed property data (object Contract)
        • Changed property contractCustomers (array)
          • Changed items (object Customer)
            • Added property preferredCorrespondenceLanguage (string)
      POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-contract-entity
      Request body :
      • Changed property companies (array)
        • Changed items (object CreateCorporateContractRequest.Company)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      • Changed property customers (array)
        • Changed items (object CreateCorporateContractRequest.Customer)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-contract-entity
      Request body :
      • Changed property companies (array)
        • Changed items (object CreateCorporateContractRequest.Company)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      • Changed property customers (array)
        • Changed items (object CreateCorporateContractRequest.Customer)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
      Response:
      • Changed property data (object Contract)
        • Changed property contractCustomers (array)
          • Changed items (object Customer)
            • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/contracts/{contractReference}
      Response:
      • Changed property data (object Contract)
        • Changed property contractCustomers (array)
          • Changed items (object Customer)
            • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/corporate-contracts/{contractReference}
      Response:
      • Changed property data (object CorporateContract)
        • Changed property contractCompanies (array)
          • Changed items (object Company)
            • Added property preferredCorrespondenceLanguage (string)
            • Deleted property preferredCorrespondanceLanguage (string)
        • Changed property contractCustomers (array)
          • Changed items (object Customer)
            • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
      Response:
      • Changed property data (object CorporateContract)
        • Changed property contractCompanies (array)
          • Changed items (object Company)
            • Added property preferredCorrespondenceLanguage (string)
            • Deleted property preferredCorrespondanceLanguage (string)
        • Changed property contractCustomers (array)
          • Changed items (object Customer)
            • Added property preferredCorrespondenceLanguage (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 preferredCorrespondenceLanguage (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 preferredCorrespondenceLanguage (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 preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
      Response:
      • Changed property data (array)
        • Changed items (object CorporateContract)
          • Changed property contractCompanies (array)
            • Changed items (object Company)
              • Added property preferredCorrespondenceLanguage (string)
              • Deleted property preferredCorrespondanceLanguage (string)
          • Changed property contractCustomers (array)
            • Changed items (object Customer)
              • Added property preferredCorrespondenceLanguage (string)
      GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
      Response:
      • Changed property data (array)
        • Changed items (object CorporateContract)
          • Changed property contractCompanies (array)
            • Changed items (object Company)
              • Added property preferredCorrespondenceLanguage (string)
              • Deleted property preferredCorrespondanceLanguage (string)
          • Changed property contractCustomers (array)
            • Changed items (object Customer)
              • Added property preferredCorrespondenceLanguage (string)
      POST /search-corporate-contracts
      Response:
      • Changed property data (array)
        • Changed items (object CorporateContract)
          • Changed property contractCompanies (array)
            • Changed items (object Company)
              • Added property preferredCorrespondenceLanguage (string)
              • Deleted property preferredCorrespondanceLanguage (string)
          • Changed property contractCustomers (array)
            • Changed items (object Customer)
              • Added property preferredCorrespondenceLanguage (string)
      POST /issuers/{issuerId}/corporate-contracts/{contractReference}/add-corporate-employee-cards-accounts
      Request body :
      • Changed property customers (array)
        • Changed items (object CreateCorporateContractRequest.Customer)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      POST /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/add-corporate-employee-cards-accounts
      Request body :
      • Changed property customers (array)
        • Changed items (object CreateCorporateContractRequest.Customer)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      POST /issuers/{issuerId}/corporate-contracts/create-corporate-contract
      Request body :
      • Changed property companies (array)
        • Changed items (object CreateCorporateContractRequest.Company)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)
      • Changed property customers (array)
        • Changed items (object CreateCorporateContractRequest.Customer)
          • Added property preferredCorrespondenceLanguage (string)
          • Deleted property preferredCorrespondanceLanguage (string)

      What's Deleted

      POST /issuers/{issuerId}/contract/{contractReference}/refund-fee-on-demand

      Refund fee by contract reference (beta)

      The API is used to trigger an on demand pro rata refund of Account Setup fee or Membership fee for the unutilised period

      What's Deprecated

       

      No API deprecated.

      Enable "on this page" menu on doc section
      On

      Release Notes: REST API V2 - 2.13.0

      REST API V2 - 2.13.0

      Version 2.12.0 to 2.13.0

      What's New

       

      API Reference
      POST /issuers/{issuerId}/customers/{customerReference}/addresses-and-subscriptions

      Create address for a customer and subscribe to add-on (beta)

      The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

      When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

      For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

       

      POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addresses-and-subscriptions

      Create address for a customer and subscribe to add-on by external reference (beta)

      The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

      When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

      For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

       

      POST /issuers/{issuerId}/corporate-contracts/{contractReference}/card-contracts/{cardContractReference}/reallocate

      Reallocate employee (beta)

      Reallocate employee by contract reference and card contract reference

       

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

      Reallocate employee by issuer contract external reference (beta)

      Reallocate employee by issuer contract external reference and card contract reference

       

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

      Reallocate employee by issuer card contract external reference (beta)

      Reallocate employee by contract reference and issuer card contract external reference

       

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

      Reallocate employee by issuer contract external reference and issuer card contract external reference (beta)

      Reallocate employee by issuer contract external reference and issuer card contract external reference

      What's Changed

      POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}/cancel
      Response:
      • Changed property data (object CancelAccountFutureUpdateResponse)
        • New required properties:
          • updateStatus
      POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}/cancel
      Response:
      • Changed property data (object CancelAccountFutureUpdateResponse)
        • New required properties:
          • updateStatus
      PATCH /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates/{futureChangeReference}
      Response:
      • Changed property data (object ModifyAccountFutureUpdateResponse)
        • New required properties:
          • accountFutureUpdateIdentifier
          • accountIdentifier
          • futureChangeDate
          • lastUpdateDate
      POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits
      Response:
      • Changed property data (object CreateTemporaryCreditLimitResponse)

        • New required properties:

          • accountIdentifier
          • activationEndTime
          • activationStartTime
          • root
          • temporaryCreditLimitAmount
          • temporaryCreditLimitIdentifier

        • Changed property relatedTemporaryCreditLimits (array)

          • Changed items (object RelatedTemporaryCreditLimit)
            • New required properties:
              • accountIdentifier
              • root
              • temporaryCreditLimitIdentifier
      DELETE /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/temporary-credit-limits/{temporaryCreditLimitReference}
      Response:
      • Changed property data (object DeleteTemporaryCreditLimitResponse)

        • New required properties:

          • accountIdentifier
          • root

        • Changed property relatedTemporaryCreditLimits (array)

          • Changed items (object RelatedTemporaryCreditLimit)
            • New required properties:
              • accountIdentifier
              • root
              • temporaryCreditLimitIdentifier
      PATCH /issuers/{issuerId}/accounts/{accountReference}/account-future-updates/{futureChangeReference}
      Response:
      • Changed property data (object ModifyAccountFutureUpdateResponse)
        • New required properties:
          • accountFutureUpdateIdentifier
          • accountIdentifier
          • futureChangeDate
          • lastUpdateDate
      POST /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits
      Response:
      • Changed property data (object CreateTemporaryCreditLimitResponse)

        • New required properties:

          • accountIdentifier
          • activationEndTime
          • activationStartTime
          • root
          • temporaryCreditLimitAmount
          • temporaryCreditLimitIdentifier

        • Changed property relatedTemporaryCreditLimits (array)

          • Changed items (object RelatedTemporaryCreditLimit)
            • New required properties:
              • accountIdentifier
              • root
              • temporaryCreditLimitIdentifier
      DELETE /issuers/{issuerId}/accounts/{accountReference}/temporary-credit-limits/{temporaryCreditLimitReference}
      Response:
      • Changed property data (object DeleteTemporaryCreditLimitResponse)

        • New required properties:

          • accountIdentifier
          • root

        • Changed property relatedTemporaryCreditLimits (array)

          • Changed items (object RelatedTemporaryCreditLimit)
            • New required properties:
              • accountIdentifier
              • root
              • temporaryCreditLimitIdentifier
      POST /issuers/{issuerId}/cards/{cardReference}/create-emergency-card
      Response:
      • Changed property data (object CreateEmergencyCardResponse)
        • New required properties:
          • panReference
      POST /issuers/{issuerId}/cards/external-cards/{issuerCardExternalReference}/create-emergency-card
      Response:
      • Changed property data (object CreateEmergencyCardResponse)
        • New required properties:
          • panReference
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}
      Response:
      • Changed property data (object Account)
        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
      POST /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/account-future-updates
      Response:
      • Changed property data (object CreateAccountFutureUpdateResponse)
        • New required properties:
          • accountFutureUpdateIdentifier
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations/{operationId}
      Response:
      • Changed property data (object Operation)
        • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/{accountReference}
      Response:
      • Changed property data (object Account)
        • Added property originalAccountIdentifierType (string)
        • Added property changedAccountIdentifierType (string)
      POST /issuers/{issuerId}/accounts/{accountReference}/account-future-updates
      Response:
      • Changed property data (object CreateAccountFutureUpdateResponse)
        • New required properties:
          • accountFutureUpdateIdentifier
      GET /issuers/{issuerId}/accounts/{accountReference}/operations/{operationId}
      Response:
      • Changed property data (object Operation)
        • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/last/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/next/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/statements/{cycleClosureDate}/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/statements/last/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/statements/next/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/statements/{cycleClosureDate}/operations
      Response:
      • Changed property data (array)
        • Changed items (object Operation)
          • Added property schemeTransactionIdentifier (string)
      GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/accounts
      Response:
      • Changed property data (array)
        • Changed items (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/close
      Response:
      • Changed property data (object CloseContractResponse)
        • Changed property contract (object CloseContractResponse.Contract)
          • Changed property cardContracts (array)
            • Changed items (object CloseContractResponse.CardContract)
              • Changed property cards (array)
                • Changed items (object CloseContractResponse.Card)
                  • New required properties:
                    • panReference
      POST /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}/suspend
      Response:
      • Changed property data (object SuspendContractResponse)
        • Changed property contract (object SuspendContractResponse.Contract)
          • Changed property cardContracts (array)
            • Changed items (object SuspendContractResponse.CardContract)
              • Changed property cards (array)
                • Changed items (object SuspendContractResponse.Card)
                  • New required properties:
                    • panReference
      GET /issuers/{issuerId}/contracts/{contractReference}/accounts
      Response:
      • Changed property data (array)
        • Changed items (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      POST /issuers/{issuerId}/contracts/{contractReference}/close
      Response:
      • Changed property data (object CloseContractResponse)
        • Changed property contract (object CloseContractResponse.Contract)
          • Changed property cardContracts (array)
            • Changed items (object CloseContractResponse.CardContract)
              • Changed property cards (array)
                • Changed items (object CloseContractResponse.Card)
                  • New required properties:
                    • panReference
      POST /issuers/{issuerId}/contracts/{contractReference}/suspend
      Response:
      • Changed property data (object SuspendContractResponse)
        • Changed property contract (object SuspendContractResponse.Contract)
          • Changed property cardContracts (array)
            • Changed items (object SuspendContractResponse.CardContract)
              • Changed property cards (array)
                • Changed items (object SuspendContractResponse.Card)
                  • New required properties:
                    • panReference
      GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/accounts
      Response:
      • Changed property data (array)
        • Changed items (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/customers/{customerReference}/accounts
      Response:
      • Changed property data (array)
        • Changed items (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/accounts/external-accounts/{issuerAccountExternalReference}/contract
      Response:
      • Changed property data (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/accounts/{accountReference}/contract
      Response:
      • Changed property data (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/card-contracts/external-card-contracts/{issuerCardContractExternalReference}/contract
      Response:
      • Changed property data (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/card-contracts/{cardContractReference}/contract
      Response:
      • Changed property data (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/{accountReference}
      Response:
      • Changed property data (object CorporateEmployeeAccountResponse)
        • Changed property account (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/corporate-contracts/{contractReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
      Response:
      • Changed property data (object CorporateEmployeeAccountResponse)
        • Changed property account (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/external-accounts/{issuerAccountExternalReference}
      Response:
      • Changed property data (object CorporateEmployeeAccountResponse)
        • Changed property account (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}/corporate-employee-accounts/{accountReference}
      Response:
      • Changed property data (object CorporateEmployeeAccountResponse)
        • Changed property account (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/contracts/external-contracts/{issuerContractExternalReference}
      Response:
      • Changed property data (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/contracts/{contractReference}
      Response:
      • Changed property data (object Contract)
        • Changed property accounts (array)
          • Changed items (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/corporate-contracts/{contractReference}
      Response:
      • Changed property data (object CorporateContract)
        • Changed property rootAccount (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
        • Changed property corporateContractEntities (array)
          • Changed items (object CorporateContractEntity)
            • Changed property account (object Account)
              • Added property originalAccountIdentifierType (string)
              • Added property changedAccountIdentifierType (string)
        • Changed property corporateEmployeeAccounts (array)
          • Changed items (object CorporateEmployeeAccount)
            • Changed property account (object Account)
              • Added property originalAccountIdentifierType (string)
              • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/corporate-contracts/external-contracts/{issuerContractExternalReference}
      Response:
      • Changed property data (object CorporateContract)
        • Changed property rootAccount (object Account)
          • Added property originalAccountIdentifierType (string)
          • Added property changedAccountIdentifierType (string)
        • Changed property corporateContractEntities (array)
          • Changed items (object CorporateContractEntity)
            • Changed property account (object Account)
              • Added property originalAccountIdentifierType (string)
              • Added property changedAccountIdentifierType (string)
        • Changed property corporateEmployeeAccounts (array)
          • Changed items (object CorporateEmployeeAccount)
            • Changed property account (object Account)
              • Added property originalAccountIdentifierType (string)
              • Added property changedAccountIdentifierType (string)
      POST /issuers/{issuerId}/contracts/search
      Response:
      • Changed property data (array)
        • Changed items (object Contract)
          • Changed property accounts (array)
            • Changed items (object Account)
              • Added property originalAccountIdentifierType (string)
              • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/contracts
      Response:
      • Changed property data (array)
        • Changed items (object Contract)
          • Changed property accounts (array)
            • Changed items (object Account)
              • Added property originalAccountIdentifierType (string)
              • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/customers/{customerReference}/contracts
      Response:
      • Changed property data (array)
        • Changed items (object Contract)
          • Changed property accounts (array)
            • Changed items (object Account)
              • Added property originalAccountIdentifierType (string)
              • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/companies/{customerReference}/corporate-contracts
      Response:
      • Changed property data (array)
        • Changed items (object CorporateContract)
          • Changed property rootAccount (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
          • Changed property corporateContractEntities (array)
            • Changed items (object CorporateContractEntity)
              • Changed property account (object Account)
                • Added property originalAccountIdentifierType (string)
                • Added property changedAccountIdentifierType (string)
          • Changed property corporateEmployeeAccounts (array)
            • Changed items (object CorporateEmployeeAccount)
              • Changed property account (object Account)
                • Added property originalAccountIdentifierType (string)
                • Added property changedAccountIdentifierType (string)
      GET /issuers/{issuerId}/companies/external-customers/{issuerCustomerExternalReference}/corporate-contracts
      Response:
      • Changed property data (array)
        • Changed items (object CorporateContract)
          • Changed property rootAccount (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
          • Changed property corporateContractEntities (array)
            • Changed items (object CorporateContractEntity)
              • Changed property account (object Account)
                • Added property originalAccountIdentifierType (string)
                • Added property changedAccountIdentifierType (string)
          • Changed property corporateEmployeeAccounts (array)
            • Changed items (object CorporateEmployeeAccount)
              • Changed property account (object Account)
                • Added property originalAccountIdentifierType (string)
                • Added property changedAccountIdentifierType (string)
      POST /search-corporate-contracts
      Response:
      • Changed property data (array)
        • Changed items (object CorporateContract)
          • Changed property rootAccount (object Account)
            • Added property originalAccountIdentifierType (string)
            • Added property changedAccountIdentifierType (string)
          • Changed property corporateContractEntities (array)
            • Changed items (object CorporateContractEntity)
              • Changed property account (object Account)
                • Added property originalAccountIdentifierType (string)
                • Added property changedAccountIdentifierType (string)
          • Changed property corporateEmployeeAccounts (array)
            • Changed items (object CorporateEmployeeAccount)
              • Changed property account (object Account)
                • Added property originalAccountIdentifierType (string)
                • Added property changedAccountIdentifierType (string)

      What's Deleted

      POST /issuers/{issuerId}/customers/{customerReference}/addressesAndSubscriptions

      Create address for a customer and subscribe to add-on (beta)

      The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

      When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

      For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

       

      POST /issuers/{issuerId}/customers/external-customers/{issuerCustomerExternalReference}/addressesAndSubscriptions

      Create address for a customer and subscribe to add-on (beta)

      The API allows to create either a permanent address or a temporary address for the customer, identified with his reference, and to subscribe to an add-on service for a contract . An address includes the following information: • the issuer address external reference • the label (eg MAIN_POSTAL_ADDRESS), • the type (mail address, phone number, email) and the corresponding data • the address usages • the start date (optional, by default, the current date is used) • the end date (conditional, only used when defining a temporary address)

      When creating a temporary address, If a temporary address already exists with an overlap on the activity period then only the newly created address will be kept and the old one will be removed.

      For information, the main postal address is mandatory. In return, the API provides the address Reference calculated by the system.

      What's Deprecated

       

      No API deprecated.

      Enable "on this page" menu on doc section
      On

      ob-p-ideal-refund

      Refund Processing

      Refunds are reversal transactions wherein complete or partial money is moved back to customer’s source account (account from which actual payment was made). Refund can only be created for a successful or settled transaction: 

      • Customer initiated refunds (returns or cancellation) - e.g. if the Customer has changed his mind about consumption of product pre/post order delivery.
      • Initiating Party initiated refunds - e.g. if a product/service is out of stock or there is a mismatch in transaction status between payment and Initiating Party wherein transaction is failed state at merchant's end but is successful at payments end. 

      For the refund processing the data from the original iDEAL request / response are used, so that the resulting refund transaction can be reconciled with the original transaction.

      Offline Refunds

      As part of the transaction processing we offer a secure Offline Refund Processing (via API's or the Backoffice). The activity diagram below describes the process. 

      Refund option for iDEAL

      The Backoffice GUI can be used to register and export refunds to a pain.001 file. This pain.001 file has to be provided to the bank of the merchant. This delivery is not done by the Open Banking Service, therefore this refund method is named 'offline'.

      Enable "on this page" menu on doc section
      On

      ob-p-a2a-refund

      Refund Processing

      Refunds are reversal transactions wherein complete or partial money is moved back to customer’s source account (account from which actual payment was made). Refund can only be created for a successful or settled transaction: 

      • Customer initiated refunds (returns or cancellation) - e.g. if the Customer has changed his mind about consumption of product pre/post order delivery.
      • Initiating Party initiated refunds - e.g. if a product/service is out of stock or there is a mismatch in transaction status between payment and Initiating Party wherein transaction is failed state at merchant's end but is successful at payments end. 

      For the refund processing the data from the original Account-to-Account request / response are used, so that the resulting refund transaction can be reconciled with the original transaction.

      As part of the transaction processing we offer a secure Refund Processing Online (via API's) or Offline (via API's or the Backoffice). The activity diagram below describes the difference between those two processes. Note: Online and Offline refunds both offer API's, those API's are different.

      Refund options

      Please note: The Refund processing allows either Online or Offline Refunds.

      Online Refunds 

      Endpoint: POST /refunds

      Use the API's to initiate payments of refunds. Multiple refunds can be payed in one go, if the merchant bank supports bulk-payments.

      Offline Refunds

      The Backoffice GUI can be used to register and export refunds to a pain.001 file. This pain.001 file has to be provided to the bank of the merchant. This delivery is not done by the Open Banking Service, therefore this refund method is named 'offline'.

      Enable "on this page" menu on doc section
      On

      ob-data-ais-notification

      Push Notification

      API Reference

      Instead of polling the consent status you may want to delegate it to Worldline. The Open Banking Service will poll the bank and notify you on consent status changes by posting notifications. Note, that bank polling happens within a few days since consent initiation. 

      POST Status

      Endpoint: POST /status

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

      This API will notify the initiating party about the status of the consent. More details about the fields can be found in the API reference.

      Data model

      Request (Click to enlarge)Response
      Post status request dataPost status response
      Enable "on this page" menu on doc section
      On

      ob-data-overview

      Data Overview

      In this section you will find implementation details of our Account Data Products:

      Bank Connect, Account Insights and Credit Insight.

      For faster integration and better user experience we offer a set of predefined screens that could be customised with your branding allowing to choose the user bank and handling the complexity of different PSD2 authorization flows (redirect / decoupled / embedded), so that you will be able to focus on your product and leave the boring stuff to us.

      Depending on the implemented product, the consent can be for one-time or for ongoing up to approximately 6 months access  to the data. Once the consent is expired you can prompt the user to renew the consent to ensure uninterrupted data access.

      The data retrieved also depends on the implemented product and could consist of account details (e.g. account name or IBAN), balances and the list of transactions. 

      Whenever a recurring consent is granted, you can access the information as many times per day as needed as long as the user is actively using your software. In case you would like to perform a background data refresh, you can do so up to 4 times per day by either polling the banking data and identifying the new transactions by yourself or by letting Worldline to pull the updated banking data multiple times per day based on a predefined schedule, comparing the results to historical data and notifying you only on the differences.

      To implement Bank Connect, Account Insights products, please review the Account Data section. We have a dedicated section for Credit Insight implementation.

      Need help?

      Please get in touch with us and we will  help you to integrate our APIs.

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