Perform an iDEAL sale request.
Methods
POST
Perform a sale request.
Request
Copied!
{
"type": "object",
"properties": {
"instruction": {
"type": "object",
"properties": {
"paymentInstrument": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"required": [
"type"
]
}
},
"value": {
"type": "object",
"properties": {
"amount": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"required": [
"amount",
"currency"
]
}
},
"required": [
"paymentInstrument",
"value"
]
},
"merchant": {
"type": "object",
"properties": {
"entity": {
"type": "string"
}
},
"required": [
"entity"
]
},
"transactionReference": {
"type": "string"
}
},
"required": [
"instruction",
"merchant",
"transactionReference"
]
}{ "type": "object", "properties": { "instruction": { "type": "object", "properties": { "paymentInstrument": { "type": "object", "properties": { "type": { "type": "object" }, "required": [ "type" ] } }, "value": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } }, "required": [ "paymentInstrument", "value" ] }, "merchant": { "type": "object", "properties": { "entity": { "type": "string" } }, "required": [ "entity" ] }, "transactionReference": { "type": "string" } }, "required": [ "instruction", "merchant", "transactionReference" ] }
Responses
Response schema
Copied!
{
"type": "object",
"properties": {
"_links": {
"type": "object",
"format": "hal+json"
},
"outcome": {
"type": "string"
}
},
"required": [
"_links",
"bankRedirectURL",
"outcome"
]
}{ "type": "object", "properties": { "_links": { "type": "object", "format": "hal+json" }, "outcome": { "type": "string" } }, "required": [ "_links", "bankRedirectURL", "outcome" ] }
Examples
Link relationship
iDEAL:actionRetrieve sale resource details
ideal Sale with an outcome of 'PendingAuthorization'
POSThttps://try.access.worldpay.com/payments/alternative/action/ideal/sale
Copied!
{
"Authorization": "Bearer Token",
"Content-Type": "application/vnd.worldpay.pay-action-v1+json",
"Accept": "application/vnd.worldpay.pay-action-v1+json"
}{ "Authorization": "Bearer Token", "Content-Type": "application/vnd.worldpay.pay-action-v1+json", "Accept": "application/vnd.worldpay.pay-action-v1+json" }
Copied!
{
"transactionReference": "reference",
"merchant": {
"entity": "entity"
},
"instruction": {
"narrative": {
"line1": "Initiate payment"
},
"paymentInstrument": {
"type": "ideal",
"bankCode": "ABN_AMRO"
},
"value": {
"currency": "USD",
"amount": 250
}
},
"url": {
"successUrl": "http://www.worldpay.com/?successURL",
"failureUrl": "http://www.worldpay.com/?failureUrl",
"cancelUrl": "http://www.worldpay.com/?cancelUrl",
"pendingUrl": "http://www.worldpay.com/?pendingUrl"
}
}{ "transactionReference": "reference", "merchant": { "entity": "entity" }, "instruction": { "narrative": { "line1": "Initiate payment" }, "paymentInstrument": { "type": "ideal", "bankCode": "ABN_AMRO" }, "value": { "currency": "USD", "amount": 250 } }, "url": { "successUrl": "http://www.worldpay.com/?successURL", "failureUrl": "http://www.worldpay.com/?failureUrl", "cancelUrl": "http://www.worldpay.com/?cancelUrl", "pendingUrl": "http://www.worldpay.com/?pendingUrl" } }
201
Copied!
{
"bankRedirectURL": "{WPG-URL to authorise the transaction}",
"outcome": "PendingAuthorization",
"_links": {
"ideal:query": {
"href": "https://try.access.worldpay.com/payments/alternative/action/ideal/query?transactionReference={transactionReference}&entity={entity}"
},
"curies": [
{
"name": "ideal",
"href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/dummyDoc/{rel}",
"templated": true
}
]
}
}{ "bankRedirectURL": "{WPG-URL to authorise the transaction}", "outcome": "PendingAuthorization", "_links": { "ideal:query": { "href": "https://try.access.worldpay.com/payments/alternative/action/ideal/query?transactionReference={transactionReference}&entity={entity}" }, "curies": [ { "name": "ideal", "href": "https://try.access.worldpay.com/rels/payments/alternative/action/ideal/dummyDoc/{rel}", "templated": true } ] } }
