/update_purchase_session

/adyen/update_purchase_session

Target audience: Developers

1
Release version: 4.2.0

Introduction

This endpoint locks or consumes an Adyen purchase session.

Attention

This API is not required for implementing the redirect purchase flow.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/adyen/update_purchase_session
Production https://backend.worldoftulo.com/external/api/v1/adyen/update_purchase_session

Requirements

Identity Scope
Yes /external/adyen/w

Curl example

1
2
3
4
5
6
7
8
curl --request POST \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/adyen/update_purchase_session \
  --header 'authorization: Bearer <token-with-identity>' \
  --header 'content-type: application/json' \
  --data '{
    "id": "5e4bfdf209c04c50ab62669d",
    "action": "lock"
  }'

Parameters

Parameter Description Required Format Type
id Id of the purchase session Yes Size range ..24
Allowed values: "/^[a-f\d]{24}$/i"
String
action Action to take. Yes LOCK / CONSUME String

Responses

1
2
3
4
HTTP 201 Updated
{
  "id": "5ea6ed5009c04c1f1a6a9c66"
}
1
2
HTTP 204 Deleted
{ }

Errors

The error response is sent as application/JSON and will have an HTTP status code ranging between 400-500.

An error message will contain these properties in every response.

Error example

1
2
3
4
5
{
  "code": "error_code",
  "field": "field",
  "message": "error message"
}