Transaction Risk Assessment

Perform a risk assessment for a given provider

This endpoint is used to do a risk assessment outside of the transaction flow. It returns a risk assessment, along with a response from the given provider.

Requires the riskAsessments:Create permission.

post/riskAssessments

Request

Request body

OR

Example request

{
  "merchantAcceptorKey": "mac-1JRadf2ffdfrdPMf2XrS2",
  "card": {
    "number": "1234123412341234",
    "holderName": "Joe Cardholder"
  },
  "amount": {
    "currency": "EUR"
  },
  "chargeType": {
    "cardEntry": "e-commerce"
  },
  "customer": {
    "firstName": "Name",
    "lastName": "Name",
    "phoneNumber": "+31(0)850609160"
  }
}

Response

Risk assessment created

keystring required

Uniquely identifies a risk assessment.

chargeKeystring

Uniquely identifies a charge.

localTransactionDateTimestring date-time

Date and time of the transaction in the local timezone.

createdstring date-time required

The date and time this object was created

lastModifiedstring date-time

The date and time this object was last modified

status'active' | 'archived' required

The status of the object

versioninteger required

The version of this object

Example response

{
  "key": "rak-1e1dAHhgstYTUhlphPzZ",
  "merchantAcceptorRef": {
    "key": "mac-1JRadf2ffdfrdPMf2XrS2"
  },
  "chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
  "card": {
    "last4": "0905"
  },
  "amount": {
    "currency": "EUR"
  },
  "chargeType": {
    "cardEntry": "e-commerce"
  },
  "customer": {
    "firstName": "Name",
    "lastName": "Name",
    "phoneNumber": "+31(0)850609160"
  },
  "result": {
    "score": 0.533506949459276,
    "recommendation": "green"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.