Create payment

post

https://example.com/api/v1/paymentmethods/ideal/v1/transactions

Create a new iDEAL payment transaction. After receiving a HTTP status 201 you have to redirect the consumer to the url given in action.redirect.url. The id field in the response can be used in future calls as transactionId to reference this transaction (for instance in a refund).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create iDEAL Transaction

returnUrls

object

required

URLs where the Consumer is redirected to after completing the transaction at its issuing bank or at the chosen payment method.

With this object we can redirect consumer to a dedicated page per payment result status. Either this object or the returnUrl field is mandatory.

reference

string

required

length between 1 and 255

The clients identifier. This value will be sent in the webhook payload alongside the ID you receive as part of the response of a transaction.

amount

integer

required

1 to 99999999

Denomination in the smallest currency subunit, as for example euro cents.

currency

string

length between 3 and 3

Defaults to EUR

ISO 4217 currency code.

language

string

length between 2 and 2

Defaults to nl

Preferred language for the user interface as ISO 639-1 code. If the provided language is not supported the default will be used. Commonly supported languages are Dutch (nl) and English (en).

webhooks

array of objects

Array of webhooks that enables receiving a web request once a given event occurs. We won't do preventive rate-limiting in order to have the highest throughput possible. However, we will honor 429 (Too-many-requests) responses per callback. We use the Retry-After header to retry after a certain period. If the header was not set we use our default exponential delay implementation.

webhooks

description

string

required

length ≤ 35

Description of the underlying value or reason of the payment.

Ultimately appears on the payment statement and confirmation screen.

expiresAt

date-time

length ≥ 20

ISO 8601 date and time. If a transaction is not finalized before this time the status becomes EXPIRED. If left empty, the value defaults to 30 mins.

purchaseId

string

required

length between 1 and 35

Unique identification of the order within the Merchant's system. This value
appears on the bank statement of the Consumer.

The purchaseID can only contain letters and numbers.

checkout

object

An iDEAL payment with iDEAL Checkout allow users to centrally manage their shipping, invoice and contact details in an iDEAL profile and provide these to a Merchant as part of the iDEAL payment.

Use this object to enable the iDEAL Checkout flow and specify the shipping costs and the consumer details to be returned after a successful payment.

requestUserToken

boolean

Defaults to false

Requests a User Token for future Pay Fast transactions with the same Consumer.

When enabled and the Consumer consents, a User Token will be generated that enables push notifications in future transactions.

Only request User Tokens for Consumers who have established accounts with your service and can be reliably identified on return visits.

expectedDebtor

object

If the Merchant is in possession of a User Token, obtained through a previous transaction, and the Consumer has indicated that he wants to reuse the bank account that was displayed after retrieving it from the getDebtorPreferences-endpoint, the User Token and browsers user-agent can be provided to enable the enhanced flow.

The Consumer for which a User Token is used MUST hold an account with the merchant. The Merchant MUST only use the iDEAL User Token that was received in the last transaction for the Consumer.

Responses

201The iDEAL transaction was created successfully. The response contains the transaction details and a redirect URL to complete the payment.

4XXThe user input was incorrect or something illegal was attempted (eg. using a service without having that service configured for the user, or not being authorized)

5XXInternal server error. This can be caused by an unresponsive backend