Place card verification

/adyen/place_card_verification

Info

Target audience: Developers
Release version: 4.4.7

Place card verification

Introduction

This endpoint initializes and performs a 0 amount verification transaction. The customer will not be charged.

If you would like to perform these actions separately, we recommend using the initialize_verification and perform_card_verification endpoints instead.

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/place_card_verification
Production	https://backend.worldoftulo.com/external/api/v1/adyen/place_card_verification

Requirements

Identity	Scope
Yes	/external/adyen/w

Curl example

curl --request POST \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/adyen/place_card_verification \
  --header 'authorization: Bearer <token-with-identity>' \
  --header 'content-type: application/json' \
  --data '{    
    "order_id": "ORGANISATION-1",
    "origin": "https://purchase.example.com",
    "return_url": "https://receipt.example.com",
    "payment_method": {
      "type": "scheme",
      "issuer": "265"
    },
    "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",
        "referer": "https://adeprimokuriren.se",
        "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
      }

  }'

Parameters

Parameter	Description	Required	Format	Type
order_id	The associated order id that should have it's card details verified/updated	Yes	Size range: ..1024	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
return_url	URI where the user should be redirected after the verification (E.g. https://receipt.example.org)	Yes	Size range: ..1024 Allowed values: uri regex that is too long to show here. Must be absolute	String
payment_method	Payment method received from state data in onSubmit event	Yes	Provided by Adyen widget	Object
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
referer	Origin URI of the request	Yes	e.q. "https://adeprimokuriren.se"	String
accept_header	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	Color depth of client browser	Yes	e.q. 24	Integer
screen_height	Screen height of client browser	Yes	e.q. 723	Integer
screen_width	Screen width of client browser	Yes	e.q. 1536	Integer
time_zone_offset	TimeZoneOffset of client browser	Yes	e.q. 0	Integer
java_enabled	Is java enabled on client browser	Yes	e.q. true/false	Boolean

Errors

This API uses the common error conventions of the Payway API

See common error responses