Skip to content

Place order


Target audience: Developers

Release version: 4.2.0

Place order


This endpoint places an Adyen order. Depending on the result further actions might need to be taken. Read more here.


This API gives access to Adyen related endpoints. Since this section is quite specific it has it's own section of documentation. Read more here.


Environment URI


Identity Scope
Yes /external/adyen/w

Curl example

curl --request POST \
  --url \
  --header 'authorization: Bearer <token-with-identity>' \
  --header 'content-type: application/json' \
  --data '{
  "payment_method": {
    "type": "scheme",
    "issuer": "265"
  "product_code": "package_code",
  "period_id": "5e4beac909c04c404a46c730",
  "return_url": "",
  "traffic_source": "facebook",
  "subscription_start_date": "2015-05-15",
  "discount_code": "code",
  "merchant_reference": "adeprimo-campaign-001",
  "origin": "",
  "browser_info": {
    "browser_ip": "",
    "browser_language": "sv-FI",
    "browser_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36",
    "referer": "",
    "accept_header": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
    "color_depth": 24,
    "screen_height": 723,
    "screen_width": 1536,
    "time_zone_offset": 0,
    "java_enabled": true
  "delivery_address": {
    "first_name": "Donald",
    "last_name": "Duck",
    "street": "Webfoot Walk",
    "street_number": "1313",
    "zip_code": "83145",
    "city": "Ankeborg",
    "country_code": "SE"
Parameter Description Required Format Type
payment_method Payment method received from state data in onSubmit event Yes Provided by Adyen widget Object
product_code The product code for a package/campaign. Yes Size range: 1..50 Allowed values: "/^[a-zA-Z-_0-9]+$/" String
period_id Id of the selected payment period Yes Size range ..24
Allowed values: "/^[a-f\d]{24}$/i"
return_url URI for payment provider redirects, e.q. 3D Secure 1 Yes Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute String
origin URI where purchase is performed (E.g. Yes Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute String
traffic_source The source of the purchase. E.g. facebook, web. Traffic sources need to be setup in PAP Optional Size range: ..100 String
subscription_start_date Date when the subscription will be activated
Note that this property will be ignored if voucher_purchase is set to true
Optional Allowed values: 2020-05-15 DateTime
discount_code Discounted price. Code needs to be defined in PAP Optional Size range: 1..100 String
merchant_reference An optional customer reference, can be a code or an url. Optional Size range: ..1024 String
browser_info Information about client browser Yes Object
Client ip-address Yes e.q. "" String
Client language Yes e.q. "sv-FI" or "sv-SE" String
Client user agent Yes e.q. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36" String
Origin URI of the request Yes e.q. "" String
Client accept header Yes e.q. "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,/;q=0.8" String
Color depth of client browser Yes e.q. 24 Integer
Screen height of client browser Yes e.q. 723 Integer
Screen width of client browser Yes e.q. 1536 Integer
TimeZoneOffset of client browser Yes e.q. 0 Integer
Is java enabled on client browser Yes e.q. true/false Boolean
delivery_address Address object. Fields marked as required is always required in order to update any field of the address. Optional Object
First name Required String
Last name Required String
Streetname Required String
The street number, some subscription-systems only allow numerical values Optional String
The zipcode Required String
The floor Optional String
The apartment number Optional String
The staircase Optional String
The city Required String
Dropbox Optional String
Country code Required SE, FI or AX String
voucher_purchase Decides whether the order should be handled as a subscription or voucher.
Read more here
Optional Boolean
voucher_details Contains information about the voucher if voucher_purchase is set to true Optional Object
The date the voucher is no longer valid Required DateTime
paywall_id The ID of the paywall.
Size range: ..24
Allowed values: "/^[a-f\d]{24}$/i"
Optional Size range ..24
Allowed values: "/^[a-f\d]{24}$/i"

Here we can receive three types of answers. Depending on the status code received you will have to perform additional actions to complete the payment.

Purchase complete

HTTP 200 Purchase complete
  "item": {
    "receipt_id": "5e4becc109c04c404a46c744",
    "order_id": "ADEPRIMO-123",
    "message": "The payment was successfully authorised.",
    "status": "complete"
If the status is "complete" then no additional actions need to be taken.

The "receipt_id" can be used to fetch the receipt for the recently made payment using the Me API.

Payment pending
HTTP 200 Payment pending
  "item": {    
    "message": "It's not possible to obtain the final status of the payment at this time.",
    "status": "pending"

If the status is "pending" the user has completed the payment but the final result is not yet known. Payway will receive a callback when it is.

Payway either fails or completes the payment depending on the result.

For a successful result, the events associated with a completed purchase will be triggered. For instance order_closed.

In turn, all the events associated with a failed purchase will be triggered on an unsuccessful result. For instance payment_failure.

Action required
HTTP 200 Action required
  "item": {
    "action": {
      "paymentMethodType": "scheme",
      "token": "eyJ0aHJlZURTTWV0aG9kTm90aWZpY...",
      "type": "threeDS2Fingerprint"
    "session_reference": "session_reference",
    "message": "The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.",
    "status": "action_required"

If you receive the status "action_required" you need to perform additional action(s) to complete the purchase.

See here for more info.


This API uses the common error conventions of the Payway API

See common error responses