Get transaction score overview

GET 
/TransactionScores/TransactionOverviewScore/:transactionCode

Get transaction score overview

Request

Path Parameters

transactionCode stringrequired

The transaction code.

Responses

200

The transaction scores with the specified code.

application/json

Schema

Schema

• Array [
transCode stringnullablerequired

The unique code identifying the transaction.

transId uuidrequired

The trans id.

transMemberType int32required

The type of transaction member being scored (e.g., beneficiary, originator, carrier).

scoreSn int32required

The sequential number of the scoring run.

scoreDate date-timerequired

The date and time when the scoring was performed.

scoreResult doublerequired

The computed score result.

scoreMaxRule int32nullablerequired

The maximum rule score applied during this scoring run.

amlTransactionScoreDetails object[]nullable
The aml transaction score details.
Array [
id int32required
The unique identifier of this record.
ruleCode stringnullablerequired
The unique code identifying the AML rule.
ruleName stringnullablerequired
The display name of the rule.
ruleApplied booleanrequired
Indicates whether this rule was applied during scoring.
ruleScore doublerequired
The score value assigned when this rule is triggered.
ruleVersion int32required
The version number of the rule definition.
groupCode stringnullablerequired
The unique code identifying the customer group.
groupName stringnullablerequired
The display name of the group.
groupVersion int32required
The version number of the group definition.
ruleScoreFinal doublerequired
The final adjusted score contributed by this rule.
ruleErrorMessage stringnullablerequired
The error message if the rule evaluation failed.
scoreSn int32required
The sequential number of the scoring run.
transCode stringnullablerequired
The unique code identifying the transaction.
transId uuidrequired
The trans id.
transMemberType int32required
The type of transaction member being scored (e.g., beneficiary, originator, carrier).
transScoreRulesDetails object[]nullable
The trans score rules details.
Array [
objectCode stringnullablerequired
The unique code identifying the AML object.
objectName stringnullablerequired
The display name of the AML object.
objectVersion int32nullablerequired
The version number of the object definition.
objectResult stringnullablerequired
The evaluated result of the AML object.
operator stringnullablerequired
The comparison operator used in the rule condition (e.g., >, <, =).
valueFrom stringnullablerequired
The lower bound or starting value for the rule condition.
valueFromVersion int32nullablerequired
The version of the lower bound value definition.
valueFromResult stringnullablerequired
The evaluated result of the lower bound value.
valueTo stringnullablerequired
The upper bound or ending value for the rule condition.
valueToVersion int32nullablerequired
The version of the upper bound value definition.
valueToResult stringnullablerequired
The evaluated result of the upper bound value.
groupCode stringnullablerequired
The unique code identifying the customer group.
ruleCode stringnullablerequired
The unique code identifying the AML rule.
scoreSn int32nullablerequired
The sequential number of the scoring run.
transCode stringnullablerequired
The unique code identifying the transaction.
transId uuidnullablerequired
The trans id.
transMemberType int32required
The type of transaction member being scored (e.g., beneficiary, originator, carrier).
]
]
• ]

Example (from schema)

[
  {
    "transCode": "string",
    "transId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transMemberType": 0,
    "scoreSn": 0,
    "scoreDate": "2024-07-29T15:51:28.071Z",
    "scoreResult": 0,
    "scoreMaxRule": 0,
    "amlTransactionScoreDetails": [
      {
        "id": 0,
        "ruleCode": "string",
        "ruleName": "string",
        "ruleApplied": true,
        "ruleScore": 0,
        "ruleVersion": 0,
        "groupCode": "string",
        "groupName": "string",
        "groupVersion": 0,
        "ruleScoreFinal": 0,
        "ruleErrorMessage": "string",
        "scoreSn": 0,
        "transCode": "string",
        "transId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "transMemberType": 0,
        "transScoreRulesDetails": [
          {
            "objectCode": "string",
            "objectName": "string",
            "objectVersion": 0,
            "objectResult": "string",
            "operator": "string",
            "valueFrom": "string",
            "valueFromVersion": 0,
            "valueFromResult": "string",
            "valueTo": "string",
            "valueToVersion": 0,
            "valueToResult": "string",
            "groupCode": "string",
            "ruleCode": "string",
            "scoreSn": 0,
            "transCode": "string",
            "transId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "transMemberType": 0
          }
        ]
      }
    ]
  }
]

400

Bad Request

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

A transaction score with the specified code could not be found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

406

Not Acceptable

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...