authenticate

POST 
/v1/3ds/:id/authenticate

authenticate

Request

Path Parameters

id stringrequired
Example: ebae6ded-9c3b-487b-9e06-db06af2565e6

application/json

Body

number stringrequired

Possible values: Value must match regular expression ^[0-9]{13,19}$

month integerrequired

Possible values: >= 1 and <= 12

year integerrequired

Possible values: >= 2000

channel stringrequired

Possible values: [browser, decoupled]

Default value: browser

return_url urirequired
statement_descriptor string

Possible values: non-empty and <= 40 characters

challenge_preference stringrequired

Possible values: [no_preference, no_challenge, preferred, mandated]

Default value: no_preference

customerobject

name string

Possible values: >= 2 characters and <= 45 characters

email email

Possible values: <= 254 characters

mobile string

Possible values: non-empty and <= 18 characters

billing_addressobject

city string

Possible values: non-empty and <= 50 characters

country string

Possible values: Value must match regular expression ^[A-Z]{2}$

line_1 string

Possible values: non-empty and <= 50 characters

line_2 string

Possible values: non-empty and <= 50 characters

postal_code string

Possible values: non-empty and <= 16 characters

state string

Possible values: non-empty and <= 50 characters

shipping_addressobject

city string

Possible values: non-empty and <= 50 characters

country string

Possible values: Value must match regular expression ^[A-Z]{2}$

line_1 string

Possible values: non-empty and <= 50 characters

line_2 string

Possible values: non-empty and <= 50 characters

postal_code string

Possible values: non-empty and <= 16 characters

state string

Possible values: non-empty and <= 50 characters

customer_deviceobject

ip_address ipv4

user_agent string

Possible values: non-empty and <= 2048 characters

accept_header string

Possible values: non-empty and <= 2048 characters

javascript_enabled boolean

language string

Possible values: non-empty and <= 8 characters

color_depth string

Possible values: [1, 4, 8, 15, 16, 24, 32, 48]

screen_height integer

Possible values: >= 1 and <= 999999

screen_width integer

Possible values: >= 1 and <= 999999

timezone string

Possible values: Value must match regular expression ^-?[0-9]{1,3}$

Responses

200

authenticates a card

application/json

Schema

Schema

id string
merchantobject
id string
acquirer_id string
name string
arabic_name string
merchant_id string
rule_precedence string
status string
amount integer
currency string
return_url string
message string
failure_reason stringnullable
challenge_preference string
is_frictionless boolean
challengeobject
url string
creq string
authobjectnullable
value string
status string
eci string
version string
ds_transaction_id string
acs_transaction_id string
ds_reference_number string
acs_reference_number string
tds_purchase_date string
created_at date-time
updated_at date-time

Example (from schema)

{
  "id": "string",
  "merchant": {
    "id": "string",
    "acquirer_id": "string",
    "name": "string",
    "arabic_name": "string",
    "merchant_id": "string",
    "rule_precedence": "string"
  },
  "status": "string",
  "amount": 0,
  "currency": "string",
  "return_url": "string",
  "message": "string",
  "failure_reason": "string",
  "challenge_preference": "string",
  "is_frictionless": true,
  "challenge": {
    "url": "string",
    "creq": "string"
  },
  "auth": {
    "value": "string",
    "status": "string",
    "eci": "string",
    "version": "string",
    "ds_transaction_id": "string",
    "acs_transaction_id": "string",
    "ds_reference_number": "string",
    "acs_reference_number": "string",
    "tds_purchase_date": "string"
  },
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

Example

{
  "id": "133a0455-ec86-4e98-a7d8-0ff6df2c3a38",
  "merchant": {
    "id": "0191fb1e-9c52-7bac-bfe6-a2ca006c9d24",
    "acquirer_id": "0191fb1e-9c4f-7a6f-b084-1a4e9cc8c396",
    "name": "Merchant 11",
    "arabic_name": "الإسم العربي",
    "merchant_id": "60011",
    "rule_precedence": "acquirer"
  },
  "status": "in_progress",
  "amount": 100,
  "currency": "SAR",
  "return_url": "https://example.com",
  "message": "Challenge required",
  "failure_reason": null,
  "challenge_preference": "no_preference",
  "is_frictionless": false,
  "challenge": {
    "url": "https://eu1.threedsecurempi.com/EMVTDS/AUT?Action=ProcessCReq",
    "creq": "eyJtZXNzYWdlVmVyc2lvbiI6IjIuMi4wIiwibWVzc2FnZVR5cGUiOiJDUmVxIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiIxMzNhMDQ1NS1lYzg2LTRlOTgtYTdkOC0wZmY2ZGYyYzNhMzgiLCJhY3NUcmFuc0lEIjoiNjMxNjI4ZWQtZGQ3ZC00YTY1LTgxNzEtZTA4NTA3OTgzZWRiIiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA0In0"
  },
  "auth": {
    "value": "c29tZV92YWx1ZQ==",
    "status": "Y",
    "eci": "05",
    "version": "2.2.0",
    "ds_transaction_id": "30cef075-d09f-48d0-989c-601be2365c17",
    "acs_transaction_id": "5b98f216-a856-4795-bb2b-b2897f1570f8",
    "ds_reference_number": "DS_SERVER_REF_1234",
    "acs_reference_number": "ACS_SERVER_REF_1234",
    "tds_purchase_date": "20240905141222"
  },
  "created_at": "2024-09-16T13:56:13Z",
  "updated_at": "2024-09-16T13:56:13Z"
}

401

returns unauthorized

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Missing authentication information"
}

403

returns forbidden

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Unauthorized"
}

422

returns unprocessable_entity

application/json

Schema

Schema

message string
errorsobject
number string[]
month string[]
year string[]
return_url string[]

Example (from schema)

{
  "message": "string",
  "errors": {
    "number": [
      "string"
    ],
    "month": [
      "string"
    ],
    "year": [
      "string"
    ],
    "return_url": [
      "string"
    ]
  }
}

Example

{
  "message": "Data validation failed",
  "errors": {
    "number": [
      "The value must be a proper credit/debit card number."
    ],
    "month": [
      "This field is missing."
    ],
    "year": [
      "This field is missing."
    ],
    "return_url": [
      "This field is missing."
    ]
  }
}

Loading...