Complete an Adyen payment session and order

curl --request POST \
  --url https://demo.spreecommerce.org/api/v2/storefront/adyen/payment_sessions/{id}/complete \
  --header 'Content-Type: application/json' \
  --header 'X-Spree-Order-Token: <api-key>' \
  --data '
{
  "session_result": "AdyenResultData"
}
'

{
  "data": {
    "id": "3",
    "type": "adyen_payment_session",
    "attributes": {
      "adyen_id": "CS3E6B43783787E79B",
      "amount": "80.99",
      "currency": "USD",
      "channel": "iOS",
      "adyen_data": "Ab02b4c0!BQABAgCNxadId3f9NXF6OMYGXsZAoAwcnOdgINKAypoyo8GUq8UqjnT/7J8K4kNhl6tjWOpGY6t+r+4QQVVfo4IHFWtjzNkj2k9dnTS4932UyCznLC+gHbzPHcfN6rNiHBIpQo523a94EvV2Sq1Gh/3j6N2aNCjfV2TDWynQJU11uOhalgwhAnVrD3HmFtbVqM60kGiPRBfE4LwLuQ7f+7S/cdVx8HzWizvafndeRnx5lM3RQNibNRbimJ3G6YZh/HI9FwZYbxkUoq8dQl8dgdquNKAxsSO0BcC6UpTU2Z8d/z3lAsm0UlX1+YiryRut4Ipg9YqJbVt3gnj7Kh4kZFRO1hZM8NDeD9PshE8riBXDpUwJ84m+9I+cfbnwYWgfZaGuxfGG+IiiliQBWIjHefd6ukUATLWsPX6ufUL7BT3rSMx/5QMmdNrE/zMA9B1tFg5Tm8t88S6WQcSZ/vIgOv+peDml5j44OcEth6iEqxRwsmT3T0nZUhYwYUSTEykrpY9+Ly2+NWpTE+sgvXhld6SZubbbG9gIBad6TIwaKkUO0kJOx6Zvk37uU2D0z8mnWIktimBZIqhegsdBXutVyUe93xSighf/C41n69COSjALE3KCcXGCmR4NsdwJ7LesJMYLu1S4gDOObvkuW5IY2k8r6pptUWgsOxcyUvbpPMlQrjRTHAwRPxcnk0SJrSL29HwASnsia2V5IjoiQUYwQUFBMTAzQ0E1MzdFQUVEODdDMjRERDUzOTA5QjgwQTc4QTkyM0UzODIzRDY4REFDQzk0QjlGRjgzMDVEQyJ9JcDZ7NsVaMwwHpvV0vX/5b7P9FS/1TfuFbQRmlFX4vCQOLxSiyAf5P4uN7Hb2Zw4dplBl4oSEBBUvrKk5TCqjGoS1azHS8Fv5LCcl2yCDH6WBtQKzJnT6NmXl29+ILYCxETtyF9K8LwgJyu8sHs2jQnnLujLBqqjIZqDFa8TORtGiwvhtS3UMtagkkg0SkCaaaOjqtZdWrTy7C9Gy9nFZNYEfmurFZmgLRROTB3jRNwmveWvayFJl4TTtub14l+RZJDx2VgjAwqRU8btN/0xnrT9m2kg6LOyW4F9TkauPgAzY3Gu//HQOGW7VDBPq6y83mzP7iNp8Whe14NQSu29i9rBricl0f6RoWin87jRD7AtZx0MxlhNxUF579COCwNHAMhs310nntoSY5U8s13of9Wn2lDcBcg2QmSNOixMMIcBkjHpEQEZAeGzfi8OvJtjoi9TVY0VzrpSbR1dcx8MNjOUeY37H+XlWkdEkd3457zbeOuSlEbjvuDYW7tYHYWipsd4fNllXiMzKW+w6YxL2Kqj0M5B+3ihuEKg7VS3b/XKs+OS7eHGZSImAt9e4tGltEqYzdRHzm4S6pnJytaoPp7+OswEm+JQTi739w4CJeNWxr1t9dot2k9OQw3vZabeI7OTrwBc2IwtUYZ9oPlBVOibMoUwCIVmSPrSgF8nCj9S2RdZgamLNnyg1srQmWnNxtOLMnvTnWedICtoE48rMG2Q+cDrEjy11TCGK3R+LHE+LaqPv96yk3ztsHomOF7XstAvLvUAIH3Z/X5+ePNcDzV7OZkS9xcLkqGqeqR04iHGZZfLw3q4rauZMWLyxb+NkGKfgTtGhe7nq+Z7bGXWxzQh694dJf+59oGCslmfJ44cd8SX3o2JjSZ7Ew7LgQt7fj6z+yif1Bs8SH3QNZN9POsfxJggCwRIhvaPmZR7hsV75+b4jC+wU2LAHik8Nr1pt48NpCxULtKNw6ZPUbJwMVWK7gmZtqa39l7OmIs2PE54vgeZk38XBi6K1UFqoZlV667GrnwOgscob3DFPMcjZhCBYOWJNLjxjqP6pw3zf7OB/ZA1m4F6yv4LVka19rlQk0esAqfTy36KbJggRYNJdGYgDr6u2zz3NblMfZpys5mtpW8ncoBdsOeWlL+cspDGig9HINHT2CnrL9+N7oU=",
      "client_key": "test_ECRHWDLSER123456HMT57VW7XGOUDA23",
      "status": "initial",
      "expires_at": "2025-07-24T14:40:45.000Z",
      "return_url": "https://example.com/adyen/payment_sessions/redirect"
    },
    "relationships": {
      "order": {
        "data": {
          "id": "4",
          "type": "cart"
        }
      },
      "payment_method": {
        "data": {
          "id": "4",
          "type": "payment_method"
        }
      },
      "user": {
        "data": null
      }
    }
  }
}

POST

api

storefront

adyen

payment_sessions

{id}

complete

Complete an Adyen payment session and order

curl --request POST \
  --url https://demo.spreecommerce.org/api/v2/storefront/adyen/payment_sessions/{id}/complete \
  --header 'Content-Type: application/json' \
  --header 'X-Spree-Order-Token: <api-key>' \
  --data '
{
  "session_result": "AdyenResultData"
}
'

{
  "data": {
    "id": "3",
    "type": "adyen_payment_session",
    "attributes": {
      "adyen_id": "CS3E6B43783787E79B",
      "amount": "80.99",
      "currency": "USD",
      "channel": "iOS",
      "adyen_data": "Ab02b4c0!BQABAgCNxadId3f9NXF6OMYGXsZAoAwcnOdgINKAypoyo8GUq8UqjnT/7J8K4kNhl6tjWOpGY6t+r+4QQVVfo4IHFWtjzNkj2k9dnTS4932UyCznLC+gHbzPHcfN6rNiHBIpQo523a94EvV2Sq1Gh/3j6N2aNCjfV2TDWynQJU11uOhalgwhAnVrD3HmFtbVqM60kGiPRBfE4LwLuQ7f+7S/cdVx8HzWizvafndeRnx5lM3RQNibNRbimJ3G6YZh/HI9FwZYbxkUoq8dQl8dgdquNKAxsSO0BcC6UpTU2Z8d/z3lAsm0UlX1+YiryRut4Ipg9YqJbVt3gnj7Kh4kZFRO1hZM8NDeD9PshE8riBXDpUwJ84m+9I+cfbnwYWgfZaGuxfGG+IiiliQBWIjHefd6ukUATLWsPX6ufUL7BT3rSMx/5QMmdNrE/zMA9B1tFg5Tm8t88S6WQcSZ/vIgOv+peDml5j44OcEth6iEqxRwsmT3T0nZUhYwYUSTEykrpY9+Ly2+NWpTE+sgvXhld6SZubbbG9gIBad6TIwaKkUO0kJOx6Zvk37uU2D0z8mnWIktimBZIqhegsdBXutVyUe93xSighf/C41n69COSjALE3KCcXGCmR4NsdwJ7LesJMYLu1S4gDOObvkuW5IY2k8r6pptUWgsOxcyUvbpPMlQrjRTHAwRPxcnk0SJrSL29HwASnsia2V5IjoiQUYwQUFBMTAzQ0E1MzdFQUVEODdDMjRERDUzOTA5QjgwQTc4QTkyM0UzODIzRDY4REFDQzk0QjlGRjgzMDVEQyJ9JcDZ7NsVaMwwHpvV0vX/5b7P9FS/1TfuFbQRmlFX4vCQOLxSiyAf5P4uN7Hb2Zw4dplBl4oSEBBUvrKk5TCqjGoS1azHS8Fv5LCcl2yCDH6WBtQKzJnT6NmXl29+ILYCxETtyF9K8LwgJyu8sHs2jQnnLujLBqqjIZqDFa8TORtGiwvhtS3UMtagkkg0SkCaaaOjqtZdWrTy7C9Gy9nFZNYEfmurFZmgLRROTB3jRNwmveWvayFJl4TTtub14l+RZJDx2VgjAwqRU8btN/0xnrT9m2kg6LOyW4F9TkauPgAzY3Gu//HQOGW7VDBPq6y83mzP7iNp8Whe14NQSu29i9rBricl0f6RoWin87jRD7AtZx0MxlhNxUF579COCwNHAMhs310nntoSY5U8s13of9Wn2lDcBcg2QmSNOixMMIcBkjHpEQEZAeGzfi8OvJtjoi9TVY0VzrpSbR1dcx8MNjOUeY37H+XlWkdEkd3457zbeOuSlEbjvuDYW7tYHYWipsd4fNllXiMzKW+w6YxL2Kqj0M5B+3ihuEKg7VS3b/XKs+OS7eHGZSImAt9e4tGltEqYzdRHzm4S6pnJytaoPp7+OswEm+JQTi739w4CJeNWxr1t9dot2k9OQw3vZabeI7OTrwBc2IwtUYZ9oPlBVOibMoUwCIVmSPrSgF8nCj9S2RdZgamLNnyg1srQmWnNxtOLMnvTnWedICtoE48rMG2Q+cDrEjy11TCGK3R+LHE+LaqPv96yk3ztsHomOF7XstAvLvUAIH3Z/X5+ePNcDzV7OZkS9xcLkqGqeqR04iHGZZfLw3q4rauZMWLyxb+NkGKfgTtGhe7nq+Z7bGXWxzQh694dJf+59oGCslmfJ44cd8SX3o2JjSZ7Ew7LgQt7fj6z+yif1Bs8SH3QNZN9POsfxJggCwRIhvaPmZR7hsV75+b4jC+wU2LAHik8Nr1pt48NpCxULtKNw6ZPUbJwMVWK7gmZtqa39l7OmIs2PE54vgeZk38XBi6K1UFqoZlV667GrnwOgscob3DFPMcjZhCBYOWJNLjxjqP6pw3zf7OB/ZA1m4F6yv4LVka19rlQk0esAqfTy36KbJggRYNJdGYgDr6u2zz3NblMfZpys5mtpW8ncoBdsOeWlL+cspDGig9HINHT2CnrL9+N7oU=",
      "client_key": "test_ECRHWDLSER123456HMT57VW7XGOUDA23",
      "status": "initial",
      "expires_at": "2025-07-24T14:40:45.000Z",
      "return_url": "https://example.com/adyen/payment_sessions/redirect"
    },
    "relationships": {
      "order": {
        "data": {
          "id": "4",
          "type": "cart"
        }
      },
      "payment_method": {
        "data": {
          "id": "4",
          "type": "payment_method"
        }
      },
      "user": {
        "data": null
      }
    }
  }
}

Authorizations

X-Spree-Order-Token

string

header

required

Order token to authorize Cart and Checkout requests.

How to obtain X-Spree-Order-Token

Body

application/json

session_result

string

required

The Adyen payment session result

Response

200 Success - Returns the Adyen Payment Session with session data and payment amount.

data

object

Show child attributes

data.id

string

Example:

"3"

data.type

string

default:adyen_payment_session

data.attributes

object

Show child attributes

data.attributes.adyen_id

string

The Adyen session ID

Example:

"CS3E6B43783787E79B"

data.attributes.amount

string

The payment amount

Example:

"80.99"

data.attributes.currency

string

The payment currency

Example:

"USD"

data.attributes.client_key

string

The Adyen client key

Example:

"your_client_key"

data.attributes.adyen_data

string

The Adyen session data required for payment processing

data.attributes.channel

enum<string>

default:Web

The channel of the payment session

Available options:

Web,

Android,

iOS

Example:

"Android"

data.attributes.return_url

string

URL to return back to store after payment with redirect flow like Klarna or iDEAL. The URL must not include personally identifiable information (PII), for example name or email address.

Example:

"https://{host}/adyen/payment_sessions/redirect"

data.attributes.status

string

The status of the payment session

Example:

"initial"

data.attributes.expires_at

string<date-time>

The expiration date and time of the payment session

Example:

"2025-07-24T14:40:45.000Z"

data.relationships

object

Show child attributes

data.relationships.order

object

Show child attributes

data.relationships.order.data

object

Show child attributes

data.relationships.order.data.id

string

Example:

"4"

data.relationships.order.data.type

string

Example:

"cart"

data.relationships.payment_method

object

Show child attributes

data.relationships.payment_method.data

object

Show child attributes

data.relationships.payment_method.data.id

string

Example:

"4"

data.relationships.payment_method.data.type

string

Example:

"payment_method"

data.relationships.user

object

Show child attributes

data.relationships.user.data

unknown

Create an Adyen Payment Session

Get Adyen Payment Session

⌘I

API basics

Tutorials

Storefront API

Platform API

Complete an Adyen payment session and order

Authorizations

Body

Response