/initialize_verification

/adyen/initialize_verification

Info

Target audience: Developers
Release version: 4.2.3

Introduction

This endpoint initializes an Adyen verification session for a 0 amount verification purchase. This is applicable when integrating with the redirect flow.

After initialization of a verification transaction you complete the verification by performing a request to the perform card verification endpoint.

Attention

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

URI

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

Requirements

Identity Scope
Yes /external/adyen/w

Curl example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
curl --request POST \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/adyen/initialize_verification \
  --header 'authorization: Bearer <token-with-identity>' \
  --header 'content-type: application/json' \
  --data '{
    "order_id": "ORDER-123",
    "origin": "https://purchase.example.com",
    "complete_url": "https://example.com/success",
    "error_url": "https://example.com/error",
    "cancel_url": "https://example.com/cancel",
    "browser_info": {
      "browser_ip": "127.0.0.1",
      "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"
    }    
  }'

Parameters

Parameter Description Required Format Type
order_id The payway order id to perform the verification for Yes Size range: ..1024 String
complete_url Callback url for successful purchase Yes Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute String
error_url Callback url for failed purchase Yes Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute String
cancel_url Callback url for cancelled purchase 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. https://purchase.example.org) Yes Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute String
browser_info Information about client browser Yes Object
browser_ip
 Client ip-address Yes e.q. "127.0.0.1" String
browser_language
 Client language Yes e.q. "sv-FI" or "sv-SE" String
browser_user_agent
 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
Response
1
2
3
4
HTTP 201 Created
{
  "id": "5e4becc109c04c404a46c744"
}

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"
}