Schemas used in requests/responses of our API:

returnUrls

ParameterTypeDescriptionConstraintsRequired
successString(1...2000)Return URL to use when the transaction succeeds.
cancelledString(1...2000)Return URL to use when the transaction is cancelled.
expiredString(1...2000)Return URL to use when the transaction is expired.
failedString(1...2000)Return URL to use when the transaction is failed.

amountChangeable

ParameterTypeDescriptionConstraintsRequired
minIntThe minimum of the amount.Must be higher than 0.
maxIntThe maximum of the amount.Must be higher than the minimum and lower than 5000000.

action

ParameterTypeDescriptionConstraintsRequired
qrcodeqrcode ObjectNext action to be performed by merchant (or consumer) to complete the payment.

qrcode

ParameterTypeDescriptionConstraintsRequired
idStringIdentifier of the QR Code known by the iDEAL QR Backend of CM.
urlStringURL of the iDEAL QR code image to be shown to your customer.

payment

ParameterTypeDescriptionConstraintsRequired
paymentString(36)Payment unique identifier.
transactionString(36)Transaction unique identifier.
idealTransactionIdString(16)The 16-digit transaction ID within the iDEAL scheme as known by the issuing bank. The value can have leading zeros.
statusStringOPEN - Payment has been created. This is the initial status.
SUCCESS - Payment successfully paid.
CANCELLED - Payment has been cancelled by your customers.
EXPIRED - Payment has not succeeded; expired.
FAILURE - Payment has not succeeded; unknown reason.
createdAtString(RFC3339)Creation time.ISO 8601 date and time.
amountInt(1...99999999)Integer representing the amount of the payment. Denomination in the smallest currency subunit (e.g. eurocents).
consumerNameStringName of the customer that completed the payment.Only present in successful payments.
consumerBicString(8...11)Bank Identification Code used by the customer to complete the payment.Only present in successful payments.
consumerIbanStringIBAN used by the customer to complete the payment.Only present in successful payments.

refund

ParameterTypeDescriptionConstraintsRequired
refundedAmountInt(0...99999999)Amount in the smallest currency subunit, as for example eurocents, that has already been refunded.
refundedPendingAmountInt(1...99999999)Amount in the smallest currency subunit, as for example eurocents, that has been requested to be refunded.

summaryItem

ParameterTypeDescriptionConstraintsRequired
statusStringOPEN - Payment has been created. This is the initial status.
SUCCESS - Payment successfully paid.
CANCELLED - Payment has been cancelled by your customers.
EXPIRED - Payment has not succeeded; expired.
FAILURE - Payment has not succeeded; unknown reason.
countIntThe number of payments with the same status.
amountInt(1...99999999)Integer representing the amount of all the payments with the same status. Denomination in the smallest currency subunit (e.g. eurocents).

requestedQRCodeInBulk

ParameterTypeDescriptionConstraintsRequired
amountChangeableamountChangeable ObjectContains the minimum and maximum values for the amount of a QR code that your customers can set themselves after scanning the code.
referenceString(1...255)An identifier specified by you. If webhooks were specified in the request this identifier is added to the webhook request payload.Only when not defined in defaults.
amountInt(1...99999999)Integer representing the amount of the transaction. Denomination in the smallest currency subunit (e.g. eurocents).Only when not defined in defaults.
currencyString (ISO 4217)ISO 4217 currency code.
purchaseIdString(1...35)Identification of the order within your system. Ultimately appears on the payment confirmation (statement and confirmation screen).
descriptionString(1...255)Description of the transaction.Only when not defined in defaults.
expiresAtString(RFC3339)Expiration time.ISO 8601 date and time.Only when not defined in defaults.
reusableBooleanIndicates the QR code's ability to accept multiple successful payments.
sizeInt(100...2000)Determines the size of the image in pixels. (e.g. A size of 200 will produce an image of ~200x200 pixels)Only when not defined in defaults.
languageString(ISO 639-1)Preferred language of the user interface.ISO 639-1 language.Only when not defined in defaults.
webhooksArray of objectsWebhooks enable receiving a web request once a given event occurs.Find more details here .
returnUrlString(2000)Specifies the URL where your customers will be redirected to when the payment process is completed.Either returnUrl or returnUrls must be specified, but not both.Only when not defined in defaults.
returnUrlsreturnUrls ObjectSpecifies a URL where your customers will be redirected to per transaction status when the payment process is completed. For example, your customers will be redirected to returnUrls.success when the status of the transaction changes to SUCCESS.Either returnUrl or returnUrls must be specified, but not both.Only when not defined in defaults.

defaultsForBulkRequest

ParameterTypeDescriptionConstraintsRequired
amountChangeableamountChangeable ObjectContains the minimum and maximum values for the amount of a QR code that your customers can set themselves after scanning the code.
referenceString(1...255)An identifier specified by you. If webhooks were specified in the request this identifier is added to the webhook request payload.
amountInt(1...99999999)Integer representing the amount of the transaction. Denomination in the smallest currency subunit (e.g. eurocents).
currencyString (ISO 4217)ISO 4217 currency code.
purchaseIdString(1...35)Identification of the order within your system. Ultimately appears on the payment confirmation (statement and confirmation screen).
descriptionString(1...255)Description of the transaction.
expiresAtString(RFC3339)Expiration time.ISO 8601 date and time.
reusableBooleanIndicates the QR code's ability to accept multiple successful payments.
sizeInt(100...2000)Determines the size of the image in pixels. (e.g. A size of 200 will produce an image of ~200x200 pixels)
languageString(ISO 639-1)Preferred language of the user interface.ISO 639-1 language.
webhooksArray of objectsWebhooks enable receiving a web request once a given event occurs.Find more details here .
returnUrlString(2000)Specifies the URL where your customers will be redirected to.Either returnUrl or returnUrls must be specified, but not both.✅ See Constraints
returnUrlsreturnUrls ObjectSpecifies a URL where your customers will be redirected to per transaction status. For example, your customers will be redirected to returnUrls.success when the status of the transaction changes to SUCCESS.Either returnUrl or returnUrls must be specified, but not both.✅ See Constraints

error

ParameterTypeDescriptionConstraintsRequired
idString(36)Unique identifier of the error.
messageStringA message indicating details of the error.

QRCodesInBulk

ParameterTypeDescriptionConstraintsRequired
createdBooleanIndicates if a QR code transaction has been created or not.
transactionQRTransaction ObjectQR transaction details.Either transaction or error must be present, but not both.✅ See Constraints
errorerror ObjectError details.Either transaction or error must be present, but not both.✅ See Constraints

QRTransaction

ParameterTypeDescriptionConstraintsRequired
idString(36)Transaction unique identifier. It can be used to retrieve the iDEAL QR code transaction details by using it in combination with other endpoints provided in this api.
actionaction ObjectThe next action to be performed by you for this transaction. This includes the URL of the iDEAL QR code image to be shown to your customer.