Skip to main content

Release Notes

The debiX API follows semantic versioning. If a release version is not listed, it does not include any changes to the interface definitions.

1.17.0​

  • Upgraded to OAS 3.1.0.
  • Enhanced description of cardBlockReason in PUT/cards/status.
  • Enhanced description of BlockedCardReplacement in PUT/cards/status and POST /cards/details.

1.16.1​

  • The OnlineLimits field in POST /cards/details is no longer deprecated.

1.15.2​

  • Standardized examples.
  • Improved Java sample code.

1.15.1​

  • Aligned SubCardType description to debol docs.

1.14.0​

  • Remove error code 4441 as Set PIN is now allowed for virtual cards as well.
  • Switch to latest certificate: debix-to-issuer-jws-signing-key signing with thumbprint f1ecc61a6f3aeaed65268fde15eab2161de60dad.

1.13.0​

  • Add new error codes for /encrypt-card-data/click-to-pay endpoint.

1.12.3​

  • Thales authorization-code is valid for 20 seconds now.
  • Add JTI containing a UUID to the claims in the authorization-code.

1.12.0​

  • Bugfix: Replaced wallet with walletType in PresentmentSearchRequestFilter and Presentment.
  • Bugfix: Changed error code for unknown wallet type for /presentments/search.

1.11.0​

  • Marked OnlineLimits from /cards/details response as deprecated.
  • Bugfix: Replaced cardId with shortCardId and added optional properties cardExpiry and cardSeqNumber in Presentment
  • Add /cards/click-to-pay/status endpoint.

1.10.0​

  • Add tokenRequestorId and tokenRequestorName to DigitalCardSearchRequestFilter for endpoint /digitalcards/search.
  • Add tokenRequestorId and tokenRequestorName to response of endpoint /digitalcards/search.
  • Add tokenRequestorId and tokenRequestorName to response of endpoint /digitalcards/{dpan}.

1.9.2​

  • Add license module entitlement checks on endpoints.
  • Add authorization concept documentation.

1.9.1​

  • Add country to ClickToPayIssuerClientInformation for /cards/encrypt-card-data/click-to-pay.

1.9.0​

  • Add endpoint to retrieve presentments: /presentments/search

1.8.0​

  • Add blockOrigin, blockInterface, blockedCardReplacement and unblockCardByCardholderAllowed to CommonCardInformation for /cards/details.
  • Add optional cardBlockOrigin and blockedCardReplacement to PUT /cards/status.
  • Add digitalCardStatusUpdateReason to DigitalCard.
  • Add missing type property to ClickToPayIssuerClientInformation, AccountAuthority and PaymentAuthenticationMethods.
  • Add missing error codes in documentation for /cards/encrypt-card-data/click-to-pay.
  • Changed content-type on /credentials request to text/plain, no change necessary for existing customers.

1.4.3​

  • Add missing content definition for response code 400, 404 for the merchant logo service: 'merchant/{merchant_entity_id}/logo'
  • Add missing error code 4455 to the documentation.
  • Add minlength=1 Contact website and phonenumber.
  • Add endpoint to get the merchant logo: '/merchants/{merchantId}/logo'.
  • Add merchant data to the transaction if the issuer is subscribed to Trx-Enrichment.

1.3.1​

  • Add SMS_ONLY authentication method to ThreeDsData for the endpoint /cards/3ds (POST and PUT).

1.3.0​

  • Add endpoint to encrypt card data for Click to Pay: /cards/encrypt-card-data/click-to-pay.
  • Replaced error code PIN_PREVIOUSLY_INHERITED | 4442 with PIN_PREVIOUSLY_PASSED_TO_NEWER_CARD | 4442 and added it to /cards/start-set-pin and /cards/set-pin.

1.2.18​

  • Add AuthId to Partial-/ThreeDsData. It will replace EmCertId as a 3DS device identifier in a future release.
  • Set EmCertId to deprecated.
  • Deprecate moneySendReceiveAllowed and add moneySendReceiveAllowance in FeatureToggles.

1.2.10​

  • Changed content-type on /start-set-pin and /set-pin requests to text/plain, no change necessary for existing customers.

1.2.9​

  • Add new AuthenticationMethod called DELEGATED for the 3DS registration, affects POST and PUT /cards/3ds.
  • Add property blockedMerchantCategoryCodes to FeatureToggles and mark the property allowedMerchantCategoryCodes as deprecated; affects the request of POST /cards and the response of /cards/details.
  • Bugfix: Property fraudConfiguration in CardOrderRequest and property restrictedRegions in FraudConfiguration are now optional; affects the request of POST /cards and the response of /cards/details.

1.2.5​

  • Add code samples for card credentials and set pin implementation.

1.2.3​

  • Add endpoint to retrieve the status and details of a card: /cards/details.
  • Extend initial test data set.

1.1.35​

  • Add debiX certificates to distribution which allows to verify the signature of the response from /cards/start-set-pin.
  • Add Transaction.threeDsAuthenticationLevel, affects POST /transactions/search and POST /digitalcards/{dpan}/transactions.
  • Add DigitalCard.deviceType and DigitalCard.deviceName, affects /digitalcards/{dpan} and POST /digitalcards/search.

1.1.28​

  • Add endpoints to set the card PIN: /cards/start-set-pin and /cards/set-pin.
  • Added error code DIGITAL_CARD_HAS_PENDING_STATUS | 4437 to /digitalcards/status and /digitalcards/{dpan}/status.
  • Add endpoint to retrieve the status and details of a card: /cards/details.
  • Add endpoint to block and unblock a card: /cards/status.
  • Add endpoint to order a virtual card: POST /cards.

1.1.19​

  • Changed /cards/credentials to expect now CardId instead of ShortCardId.

1.1.12​

  • Changed PUT /cards/3ds to allow partial updates of 3DS data.
  • Added AuthenticationMethod.BIOMETRIC_WITH_PIN_FALLBACK.

1.1.8​

  • Changed type of CardEncryptionResponse.panSuffix to string.
  • Added CARD_INACTIVE | 4436 application error.
  • Changed CardSeqNumber minimum value to 0 and maximum value to 9.
  • Optimized 3DS endpoints
    • Changed endpoint to deregister 3ds cards from DELETE /cards/3ds to POST /cards/3ds/delete.
    • Renamed AuthenticationMethod.FINGERPRINT to BIOMETRIC.
    • Renamed FingerprintType to BiometricType.

1.1.0​

  • Add endpoints for provisioning of a funding debit card into a wallet with Thales SDK: /cards/encrypted-card-data and /cards/authorization-code.
  • Add endpoint for 3DS card registration and deregistration: /cards/3ds.
  • Add endpoint to get digital card by dpan: /digitalcards/{dpan}.

1.0.0​

  • The card identifier moved from url to request body. This resulted in
    • the merging of /cards/{bankClearingNumber}/{cardNumber}/{cardType}/transactions into /transactions/search,
    • the merging of /cards/{bankClearingNumber}/{cardNumber}/{cardType}/digitalcards into /digitalcards/search,
    • the renaming of /cards/{bankClearingNumber}/{cardNumber}/{cardType}/digitalcards/status to /digitalcards/status.

0.0.16​

  • Add endpoints for digital card status update: /cards/{bankClearingNumber}/{cardNumber}/{cardType}/digitalcards/status and /digitalcards/{dpan}/status.
  • Add endpoints to retrieve transactions: /cards/{bankClearingNumber}/{cardNumber}/{cardType}/transactions , /transactions/search and /digitalcards/{dpan}/transactions.

0.0.8​

  • Switch to Openapi v3.0.3.
  • Providing endpoints /healthcheck, /cards/{bankClearingNumber}/{cardNumber}/{cardType}/digitalcards and /digitalcards/search.