{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/alt-transactions","auth":"optional","settings":"","results":{"codes":[]},"params":[],"examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create iDEAL Transaction","type":"endpoint","slug":"create-ideal-transaction","excerpt":"","body":"The Create iDEAL Transaction request performs a transaction using the iDEAL payment method. For implementation details, see the [iDEAL guide](/docs/ideal).\n\n<br>\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nSend an **[alt-transaction](doc:alt-transaction)** container, with the following:\n\n `amount` *decimal* <span style=\"color:#F37500\">**required**</span>\n `currency` *string* <span style=\"color:#F37500\">**required**</span> value must be **EUR**\n `ideal-transaction` *container* <span style=\"color:#F37500\">**required**</span> (see [ideal-transaction](doc:ideal-transaction))\n `payerInfo` *container* optional include for a new shopper (see [payer-info](doc:payer-info))\n `vaulted-shopper-id`* *integer* optional include for a vaulted shopper\n `vendors-info` *container* optional (see [vendorsInfo](doc:vendors-info))\n `merchant-transactionid` *string* optional\n `transaction-meta-data` *container* optional (see [transaction-meta-data](doc:transaction-meta-data))\n `transaction-fraud-info` *container* optional (see [transaction-fraud-info](doc:transaction-fraud-info) )\n\n* The vaulted shopper's saved country must be **nl**.\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the request properties plus these additions:\n\n `vaulted-shopper-id`\n `processing-info` (see [processing-info](doc:processing-info))\n `fraudResultInfo` (see [fraud-result-info](doc:fraud-result-info))\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Accept: application/xml' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n <amount>42.00</amount>\\n <currency>EUR</currency>\\n <payer-info>\\n <first-name>John</first-name>\\n <last-name>Doe</last-name>\\n </payer-info>\\n <ideal-transaction>\\n <return-url>http://www.returnURL.com</return-url>\\n </ideal-transaction>\\n</alt-transaction>'\",\n \"language\": \"curl\",\n \"name\": \"Create iDEAL Transaction: Basic with new shopper\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Accept: application/xml' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n <amount>42.00</amount>\\n <vaulted-shopper-id>20769005</vaulted-shopper-id>\\n <currency>EUR</currency>\\n <ideal-transaction>\\n <language>ja</language>\\n <issuerid>INGBNL2A</issuerid>\\n <return-url>http://www.returnURL.com</return-url>\\n </ideal-transaction>\\n</alt-transaction>'\",\n \"language\": \"curl\",\n \"name\": \"with returning shopper, language, & issuer ID\"\n },\n {\n \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Accept: application/xml' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n <amount>42.00</amount>\\n <currency>EUR</currency>\\n <payer-info>\\n <first-name>John</first-name>\\n <last-name>Doe</last-name>\\n <country>nl</country>\\n </payer-info>\\n <ideal-transaction>\\n <return-url>http://www.returnURL.com</return-url>\\n </ideal-transaction>\\n <vendors-info>\\n <vendor-info>\\n <vendor-id>837389</vendor-id>\\n </vendor-info>\\n </vendors-info>\\n</alt-transaction>'\",\n \"language\": \"curl\",\n \"name\": \"with marketplace vendor\"\n }\n ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n <amount>42.00</amount>\\n <currency>EUR</currency>\\n <payer-info>\\n <first-name>John</first-name>\\n <last-name>Doe</last-name>\\n <country>nl</country>\\n </payer-info>\\n <vaulted-shopper-id>28539053</vaulted-shopper-id>\\n <ideal-transaction>\\n <ideal-url>https://eu.gcsip.nl/orb/orb?ACTION=DO_START&REF=000000410000189819530000100001&MAC=Un7qml6%2BNPSydoS8FAq2ksyDdjhIl0rAWm92dNZK1QI%3D</ideal-url>\\n <order-id>18981953</order-id>\\n </ideal-transaction>\\n <processing-info>\\n <processing-status>PENDING</processing-status>\\n </processing-info>\\n</alt-transaction>\",\n \"language\": \"xml\",\n \"name\": \"Basic with new shopper\"\n },\n {\n \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n <amount>42.00</amount>\\n <currency>EUR</currency>\\n <vaulted-shopper-id>20769005</vaulted-shopper-id>\\n <ideal-transaction>\\n <language>ja</language>\\n <ideal-url>https://eu.gcsip.nl/orb/orb?ACTION=DO_START&REF=000000410000189819550000100001&MAC=t%2F8AtqOf7FP0z%2By3FvyrL7A2hYpYiJSuClDRddXjnow%3D</ideal-url>\\n <order-id>18981955</order-id>\\n </ideal-transaction>\\n <processing-info>\\n <processing-status>PENDING</processing-status>\\n </processing-info>\\n</alt-transaction>\",\n \"language\": \"xml\",\n \"name\": \"Returning shopper, language, & issuer ID\"\n },\n {\n \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n <vendors-info>\\n <vendor-info>\\n <vendor-id>837389</vendor-id>\\n <commission-percent>30</commission-percent>\\n </vendor-info>\\n </vendors-info>\\n <amount>42.00</amount>\\n <currency>EUR</currency>\\n <payer-info>\\n <first-name>John</first-name>\\n <last-name>Doe</last-name>\\n <country>nl</country>\\n </payer-info>\\n <vaulted-shopper-id>28539055</vaulted-shopper-id>\\n <ideal-transaction>\\n <ideal-url>https://eu.gcsip.nl/orb/orb?ACTION=DO_START&REF=000000410000189824370000100001&MAC=KCenXRkPJCXKGrHUhwNAYsaKsOF7P22nvDXkcpITtVI%3D</ideal-url>\\n <order-id>18982437</order-id>\\n </ideal-transaction>\\n <processing-info>\\n <processing-status>PENDING</processing-status>\\n </processing-info>\\n</alt-transaction>\",\n \"language\": \"xml\",\n \"name\": \"Marketplace vendor\"\n }\n ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Example Descriptions\nFor details about the above examples, see:\n* [Create a basic iDEAL transaction with a new shopper](#section-create-a-basic-ideal-transaction-with-a-new-shopper)\n* [Create an iDEAL transaction with a returning shopper](#section-create-an-ideal-transaction-with-a-returning-shopper)\n* [Create an iDEAL transaction with a Marketplace vendor](#section-create-an-ideal-transaction-with-a-marketplace-vendor)\n\n### Create a basic iDEAL transaction with a new shopper\nThis example shows a basic request with a new shopper whose details are included within `payer-info`. The `return-url` property specifies where the shopper should be redirected after they complete the payment. A successful response will include `ideal-url`, which is the URL you will need to direct the shopper to so they can complete their purchase. \n\n### Create an iDEAL transaction with a returning shopper\nThis example shows a request with a returning shopper whose ID is specified by the `vaulted-shopper-id` property. Note that the vaulted shopper must have a saved country of **nl**. The request includes `issuer-id`, which specifies the shopper's selected bank. This tells BlueSnap that the bank selection step can be skipped later in checkout - the shopper will be directed straight to their bank portal. Additionally, the request includes `language`, which specifies how the pages should be translated. \n\n### Create an iDEAL transaction with a Marketplace vendor\nThis example shows a request with a [Marketplace](/docs/marketplace-overview) vendor whose ID is specified by `vendor-id`. Additional vendors can be added to the transaction by including another `vendor-info` container within `vendors-info`. \n\n<br>\n\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, enter the request content below and then click **Try it!**\n\n**Tip**: Use the XML code below as a starting point. You can enter different parameters to see how your test scenario would work. *The request headers, including authorization, are already built-in for you in this test area, so you should not include them here.*\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<alt-transaction xmlns=\\\"http://ws.plimus.com\\\">\\n <amount>42.00</amount>\\n <currency>EUR</currency>\\n <payer-info>\\n <first-name>John</first-name>\\n <last-name>Doe</last-name>\\n </payer-info>\\n <ideal-transaction>\\n <return-url>http://www.returnURL.com</return-url>\\n </ideal-transaction>\\n</alt-transaction>\",\n \"language\": \"xml\"\n }\n ]\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff4b747849e1b03c50684bd","createdAt":"2020-08-27T16:50:37.064Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"iDEAL Transactions","slug":"ideal-transactions","order":4,"from_sync":false,"reference":false,"_id":"5ff4b747849e1b03c506841b","createdAt":"2020-08-27T16:49:20.046Z","version":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff4b747849e1b03c5068409","5ff4b747849e1b03c506840a","5ff4b747849e1b03c506840b","5ff4b747849e1b03c506840c","5ff4b747849e1b03c506840d","5ff4b747849e1b03c506840e","5ff4b747849e1b03c506840f","5ff4b747849e1b03c5068410","5ff4b747849e1b03c5068411","5ff4b747849e1b03c5068412","5ff4b747849e1b03c5068413","5ff4b747849e1b03c5068414","5ff4b747849e1b03c5068415","5ff4b747849e1b03c5068416","5ff4b747849e1b03c5068417","5ff4b747849e1b03c5068418","5ff4b747849e1b03c5068419","5ff4b747849e1b03c506841a","5ff4b747849e1b03c506841b","5ff4b747849e1b03c506841c"],"_id":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fd26704abd1b6004f12d72c","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}
postCreate iDEAL Transaction
Definition
Documentation
The Create iDEAL Transaction request performs a transaction using the iDEAL payment method. For implementation details, see the iDEAL guide.
Request Content
Send an alt-transaction container, with the following:
amount
decimal required
currency
string required value must be EUR
ideal-transaction
container required (see ideal-transaction)
payerInfo
container optional include for a new shopper (see payer-info)
vaulted-shopper-id
* integer optional include for a vaulted shopper
vendors-info
container optional (see vendorsInfo)
merchant-transactionid
string optional
transaction-meta-data
container optional (see transaction-meta-data)
transaction-fraud-info
container optional (see transaction-fraud-info )
* The vaulted shopper's saved country must be nl.
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the request properties plus these additions:
vaulted-shopper-id
processing-info
(see processing-info)
fraudResultInfo
(see fraud-result-info)
Examples
Request Examples
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
<amount>42.00</amount>
<currency>EUR</currency>
<payer-info>
<first-name>John</first-name>
<last-name>Doe</last-name>
</payer-info>
<ideal-transaction>
<return-url>http://www.returnURL.com</return-url>
</ideal-transaction>
</alt-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
<amount>42.00</amount>
<vaulted-shopper-id>20769005</vaulted-shopper-id>
<currency>EUR</currency>
<ideal-transaction>
<language>ja</language>
<issuerid>INGBNL2A</issuerid>
<return-url>http://www.returnURL.com</return-url>
</ideal-transaction>
</alt-transaction>'
curl -v -X POST https://sandbox.bluesnap.com/services/2/alt-transactions/ \
-H 'Content-Type: application/xml' \
-H 'Accept: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<alt-transaction xmlns="http://ws.plimus.com">
<amount>42.00</amount>
<currency>EUR</currency>
<payer-info>
<first-name>John</first-name>
<last-name>Doe</last-name>
<country>nl</country>
</payer-info>
<ideal-transaction>
<return-url>http://www.returnURL.com</return-url>
</ideal-transaction>
<vendors-info>
<vendor-info>
<vendor-id>837389</vendor-id>
</vendor-info>
</vendors-info>
</alt-transaction>'
<alt-transaction xmlns="http://ws.plimus.com">
<amount>42.00</amount>
<currency>EUR</currency>
<payer-info>
<first-name>John</first-name>
<last-name>Doe</last-name>
<country>nl</country>
</payer-info>
<vaulted-shopper-id>28539053</vaulted-shopper-id>
<ideal-transaction>
<ideal-url>https://eu.gcsip.nl/orb/orb?ACTION=DO_START&REF=000000410000189819530000100001&MAC=Un7qml6%2BNPSydoS8FAq2ksyDdjhIl0rAWm92dNZK1QI%3D</ideal-url>
<order-id>18981953</order-id>
</ideal-transaction>
<processing-info>
<processing-status>PENDING</processing-status>
</processing-info>
</alt-transaction>
<alt-transaction xmlns="http://ws.plimus.com">
<amount>42.00</amount>
<currency>EUR</currency>
<vaulted-shopper-id>20769005</vaulted-shopper-id>
<ideal-transaction>
<language>ja</language>
<ideal-url>https://eu.gcsip.nl/orb/orb?ACTION=DO_START&REF=000000410000189819550000100001&MAC=t%2F8AtqOf7FP0z%2By3FvyrL7A2hYpYiJSuClDRddXjnow%3D</ideal-url>
<order-id>18981955</order-id>
</ideal-transaction>
<processing-info>
<processing-status>PENDING</processing-status>
</processing-info>
</alt-transaction>
<alt-transaction xmlns="http://ws.plimus.com">
<vendors-info>
<vendor-info>
<vendor-id>837389</vendor-id>
<commission-percent>30</commission-percent>
</vendor-info>
</vendors-info>
<amount>42.00</amount>
<currency>EUR</currency>
<payer-info>
<first-name>John</first-name>
<last-name>Doe</last-name>
<country>nl</country>
</payer-info>
<vaulted-shopper-id>28539055</vaulted-shopper-id>
<ideal-transaction>
<ideal-url>https://eu.gcsip.nl/orb/orb?ACTION=DO_START&REF=000000410000189824370000100001&MAC=KCenXRkPJCXKGrHUhwNAYsaKsOF7P22nvDXkcpITtVI%3D</ideal-url>
<order-id>18982437</order-id>
</ideal-transaction>
<processing-info>
<processing-status>PENDING</processing-status>
</processing-info>
</alt-transaction>
Example Descriptions
For details about the above examples, see:
- Create a basic iDEAL transaction with a new shopper
- Create an iDEAL transaction with a returning shopper
- Create an iDEAL transaction with a Marketplace vendor
Create a basic iDEAL transaction with a new shopper
This example shows a basic request with a new shopper whose details are included within payer-info
. The return-url
property specifies where the shopper should be redirected after they complete the payment. A successful response will include ideal-url
, which is the URL you will need to direct the shopper to so they can complete their purchase.
Create an iDEAL transaction with a returning shopper
This example shows a request with a returning shopper whose ID is specified by the vaulted-shopper-id
property. Note that the vaulted shopper must have a saved country of nl. The request includes issuer-id
, which specifies the shopper's selected bank. This tells BlueSnap that the bank selection step can be skipped later in checkout - the shopper will be directed straight to their bank portal. Additionally, the request includes language
, which specifies how the pages should be translated.
Create an iDEAL transaction with a Marketplace vendor
This example shows a request with a Marketplace vendor whose ID is specified by vendor-id
. Additional vendors can be added to the transaction by including another vendor-info
container within vendors-info
.
API Explorer
To test out a call, enter the request content below and then click Try it!
Tip: Use the XML code below as a starting point. You can enter different parameters to see how your test scenario would work. The request headers, including authorization, are already built-in for you in this test area, so you should not include them here.
<alt-transaction xmlns="http://ws.plimus.com">
<amount>42.00</amount>
<currency>EUR</currency>
<payer-info>
<first-name>John</first-name>
<last-name>Doe</last-name>
</payer-info>
<ideal-transaction>
<return-url>http://www.returnURL.com</return-url>
</ideal-transaction>
</alt-transaction>