create

POST 
/v1/3ds

create

Request

application/json

Body

card_auth_id uuidrequired
amount integerrequired

Possible values: >= 1

currency stringrequired
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

Responses

201

returns success

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 stringnullable
message string
failure_reason stringnullable
challenge_preference string
is_frictionless booleannullable
challenge objectnullable
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": {},
  "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": "08c1d8fe-a41d-45f2-a668-7a01ec5534c9",
  "merchant": {
    "id": "0191fb1e-9c28-7718-b03c-0a00b7902b02",
    "acquirer_id": "0191fb1e-9c26-7db0-a210-9e0ec8e370e3",
    "name": "Merchant 9",
    "arabic_name": "الإسم العربي",
    "merchant_id": "6009",
    "rule_precedence": "merchant"
  },
  "status": "available",
  "amount": 100,
  "currency": "SAR",
  "return_url": null,
  "message": "Authentication is available.",
  "failure_reason": null,
  "challenge_preference": "no_preference",
  "is_frictionless": null,
  "challenge": null,
  "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:12Z",
  "updated_at": "2024-09-16T13:56:12Z"
}

400

fails when retries are exhausted

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "Initial request is still processing."
}

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
amount string[]
currency string[]
number string[]
month string[]
year string[]

Example (from schema)

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

Example

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

Loading...