Skip to main content
POST
Send payment event

Authorizations

ds-api-token
string
header
required

Body

application/json

Payment data

applicant_id
string<uuid>
required

Applicant ID (user that sends payment)

Example:

"f81d4fae-7dec-11d0-a765-00a0c91e6bf6"

checkout_billing_country
string
required

The country used for the billing address. ISO 3166-1 Alpha-2

Example:

"US"

user_ip_address
string

The IP address of the user's current session

Example:

"27.134.25.17"

user_agent
string

The full OS and browser type and version collected during the session

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:126.0) Gecko/20100101 Firefox/126.0"

user_device_id
string

The unique identifier of the user's device

Example:

"nmljasfdKsed8keM#@2k"

session_duration
integer

The number of seconds since the user started the session

Required range: x >= 0
Example:

7200

user_email_address
string

The primary e-mail address associated with the user

Example:

"myverynicelogin@example.com"

user_phone_number
string

The phone number associated with the user

Example:

"+1 123 456-898-87"

user_ds_registration
integer

The number of days since the user's online registration

Required range: x >= 0
Example:

3

user_initial_risk_score
integer

The original risk score that a customer was assigned during account registration. In range 0 <= ... <= 100

Required range: 0 <= x <= 100
Example:

15

user_current_risk_score
integer

The most current risk score that a customer has been assigned based on ongoing activity monitoring. In range 0 <= ... <= 100

Required range: 0 <= x <= 100
Example:

27

checkout_price
string

The amount the user is charged during checkout

Example:

"560.00"

checkout_isguest
boolean

Classify each checkout from a registered user, true/false

Example:

true

checkout_billing_address
string

The complete street address and unit number used for billing

Example:

"8247 Christopher Mountains Apt. 462"

checkout_billing_zip
string

The postal code used for the billing address

Example:

"27315"

checkout_card_bin
string

The first six digits of the card used for payment for the product being reviewed

Example:

"259703"

checkout_shipping_address
string

The complete street address and unit number used for shipping

Example:

"9143 Wendy Park Suite 894"

checkout_shipping_zip
string

The postal code used for the shipping address

Example:

"84639"

Response

Created event ID

event_id
string<uuid>
required

UUID of created event (you can use it for track result on WebHooks callback)

Example:

"f81d4fae-7dec-11d0-a765-00a0c91e6bf6"