Skip to main content
POST
/
api
/
v3
/
transmon
/
transaction
Send transaction event
curl --request POST \
  --url https://api.dataspike.io/api/v3/transmon/transaction \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '{
  "applicant_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "user_ip_address": "27.134.25.17",
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:126.0) Gecko/20100101 Firefox/126.0",
  "user_device_id": "nmljasfdKsed8keM#@2k",
  "session_id": "nsd,fhj734Mdksllew898233hhssa",
  "channel": "web",
  "session_duration": 86400,
  "session_login_name": "myverynicelogin",
  "session_step_up_auth_ind": false,
  "user_email_address": "myverynicelogin@example.com",
  "user_phone_number": "+1 123 456-898-87",
  "user_ds_registration": 3,
  "user_initial_risk_score": 15,
  "user_current_risk_score": 27,
  "transaction_type": "CNP",
  "routing_type": "IBAN",
  "routing_number": "a1209234883452370937",
  "currency_code": "EUR",
  "amount": "560.00",
  "account_available_balance": "1122.86",
  "ds_payee_first_transaction": 15,
  "payor_account_id": "b902387378291k22",
  "payor_country_cd": "US",
  "payor_zip": "27315",
  "payor_state": "NC",
  "payor_city": "Anytown",
  "payor_address_line_1": "8247 Christopher Mountains Apt. 462",
  "ds_account_open_date": 7,
  "ds_payor_info_updated": 10,
  "payee_entity_id": "xf9-8209-dt7",
  "payee_account_id": "z8739nm992002653721234",
  "payee_country_cd": "US",
  "payee_zip": "27315",
  "payee_state": "NC",
  "payee_city": "Anytown",
  "payee_address_line_1": "8247 Christopher Mountains Apt. 462",
  "payee_bank": "Citibank",
  "ds_payee_info_updated": 8,
  "payee_alias": "John Doe"
}'
{
  "event_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
}

Authorizations

ds-api-token
string
header
required

Body

application/json

Transaction data

applicant_id
string<uuid>
required

Applicant ID (user that sends transaction to other user)

Example:

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

payor_account_id
string
required

A unique identifier for the account that the transaction is performed on

Example:

"b902387378291k22"

payor_country_cd
string
required

The country of the payor. ISO 3166-1 Alpha-2

Example:

"US"

payee_entity_id
string
required

A unique identifier for the payee

Example:

"xf9-8209-dt7"

payee_account_id
string
required

A unique identifier for the account that the transaction is performed on

Example:

"z8739nm992002653721234"

payee_country_cd
string
required

The country of the payee. 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_id
string

The identifier for an authentication session

Example:

"nsd,fhj734Mdksllew898233hhssa"

channel
string

The channel in which transaction was originated. Allowed - "web", "mobile"

Example:

"web"

session_duration
integer

The number of seconds since the user started the session

Required range: x >= 0
Example:

86400

session_login_name
string

The user name utilized by the online user to login to the online session

Example:

"myverynicelogin"

session_step_up_auth_ind
boolean

Indicates whether the client passed a step up authentication during the session

Example:

false

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

transaction_type
string

The payment method used. Examples - "CNP", "ACH", etc.

Example:

"CNP"

routing_type
string

The format of the routing number supplied in the payee routing number field. Example - "ABA", "CHIPS", "BIC", "IBAN", "SIC"

Example:

"IBAN"

routing_number
string

The routing number for the financial institution, which holds the payee account

Example:

"a1209234883452370937"

currency_code
string

The currency associated with the amount. supply the currency code using ISO 4217 alphabetic currency codes, for example "USD", "EUR", "JPY"

Example:

"EUR"

amount
string

The transaction amount

Example:

"560.00"

account_available_balance
string

The account's current available balance (before the current transaction)

Example:

"1122.86"

ds_payee_first_transaction
integer

Days since payee was added to payee list or since first transaction to payee

Required range: x >= 0
Example:

15

payor_zip
string

The zip or postal code of the payor

Example:

"27315"

payor_state
string

The state or province of the payor

Example:

"NC"

payor_city
string

The city of the payor

Example:

"Anytown"

payor_address_line_1
string

The address of the payor

Example:

"8247 Christopher Mountains Apt. 462"

ds_account_open_date
integer

The number of days since account open date

Required range: x >= 0
Example:

7

ds_payor_info_updated
integer

The number of days since payor information last update

Required range: x >= 0
Example:

10

payee_zip
string

The zip or postal code of the payee

Example:

"27315"

payee_state
string

The state or province of the payee

Example:

"NC"

payee_city
string

The city of the payee

Example:

"Anytown"

payee_address_line_1
string

The address of the payee

Example:

"8247 Christopher Mountains Apt. 462"

payee_bank
string

The name / alias of the payee's bank

Example:

"Citibank"

ds_payee_info_updated
integer

The number of days since payee information last update

Required range: x >= 0
Example:

8

payee_alias
string

The alias, such as email address or phone number, as entered to identify the payee.

Example:

"John Doe"

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"