iDEAL - Merchant/CPSP API

Version Changelog

Version

Date

Changes

Version

Date

Changes

2.1.0

Sep 24, 2024

  • Removed non-functional amount fields and values from documentation

    • removed amount.type enum values (CHANGE and DEFINE)

    • removed amount.minimum and amount.maximum fields

  • Explanation on use of IssuerId and introduction of debtor.issuerId

2.0.6

Feb 12, 2024

  • Added request signatures for clarity within the endpoints header declarations (instead of only in security section)

  • Clarification on creditor.sub field (conditionally mandatory if creditor.cpsp is TRUE)

2.0.5

Oct 10, 2023

  • Changes in request procedure for mTLS client and signing certificates (must both be requested via Acquirer with Currence)

  • Changes in providing signing certificates in message (only leaf certificate to be provided)

  • Corrections in some of the JOSE headers (kid and jwk claims obsolete)

  • Added ES384 (ECDSA using P-384 and SHA-384) as supported signing algorithm

2.0.4

Apr 12, 2023

  • Fix all callbacks description to make it more clear

  • Added clarification for AmountBreakdown field description

  • Clarify the format of https://idealapi.nl/path BaseUrl = https://issuer.idealapi.nl, Path = the rest of URL including the version in description.

  • For TransactionReference and TransactionDescription add a small explanation It will also be shown on the bank statement of the user after payment (as part of the remittance information).

  • Remove the first bullet point of the performance criteria The maximum supported throughput (all clients combined) for this endpoint is 200 requests/second. or The maximum supported throughput (all clients combined) for this endpoint is 200 requests/second.

  • Fix return signature in error responses

2.0.3

Oct 3, 2022

  • Removed field expectedCheckoutData from GET /merchant-cpsp/transactions response

  • Renamed field expectedCheckoutData to requestedCheckoutDetails

  • Changed fields shippingAddress and invoiceAddress in requestedCheckoutDetails in POST /merchant-cpsp/transactions from object to boolean

  • Added Note to requestedCheckoutDetails that at least one field in requestedCheckoutDetails should be set to true

  • Added fields firstName and lastName to requestedCheckoutDetails.debtorContactDetails in POST /transactions

  • renamed debtor.checkoutPreferences to debtor.checkoutDetails

  • Added fields firstName and lastName to debtor.checkoutPreferences.contactDetails in GET /transactions

2.0.2

Jun 30, 2022

  • Renamed /transactions to /merchant-cpsp/transactions.

  • Renamed /transactions/{transactionId} to /merchant-cpsp/transactions/{transactionId}.

  • Renamed /debtors/{userToken}/preferences to /merchant-cpsp/debtors/{userToken}/preferences.

  • Renamed /qrcodes to /merchant-cpsp/qrcodes.

  • Renamed /qrcodes/{qrcodeId}/cancel to /merchant-cpsp/qrcodes/{qrcodeId}/cancel.

  • Renamed /qrcode to /merchant-cpsp/qrcode.

  • Added missed header in: header to JWT_Access_Token section

  • Fixed a bug in JWS-Request-Signature: change the value of <https://idealapi.nl/sub> claim from equal to JWT_Access_Token.creditor.id to equal to JWT_Access_Token.sub

  • Added an extra claim <https://idealapi.nl/token-jti> to JWS-Request-Signature in order to correlate a request signature to a specific token (security improvement)

  • Updated a critical headers section by adding <https://idealapi.nl/token-jti> and <https://idealapi.nl/scope> into it

  • Added new field finalStateDateTimestamp to GET /merchant-cpsp/transactions/{transactionId} response

2.0.1

Mar 28, 2022

  • Changed POST /qrcodes response amount type to /QRAmount. This removes the amountBreakdown field.

  • Renamed debtorToken to userToken.

  • Changed Request-ID header to a required parameter. Updated description as well.

2.0.0

Sep 15, 2021

  • Reflected the comments from Acquirer APIs

  • Fixed formatting and structure of JWT access token

  • Moved sub creditor details from JWT to CreateTransactionRequest

  • Added cpspSchemeId, c2cProviderId to JWT access token

  • Elaborated on how to provide mcc field either in JWT Access Token or in CreateTransactionRequest

  • Updated POST /transactions and POST /qrcodes to include the relevant creditor details

  • Fixed typos and grammar

 

Copyright © Currence iDEAL B.V. All rights reserved.