Get transaction score

GET 
/TransactionScores/:transScoreCode

Get transaction score

Request

Path Parameters

transScoreCode stringrequired

The trans score code.

Responses

200

The trans score with the specified trans score code.

application/json

Schema

Schema

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.

transCode stringnullablerequired

The unique code identifying the transaction.

transId uuidrequired

The trans id.

Example (from schema)

{
  "transMemberType": 0,
  "scoreSn": 0,
  "scoreDate": "2024-07-29T15:51:28.071Z",
  "scoreResult": 0,
  "scoreMaxRule": 0,
  "transCode": "string",
  "transId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

304

The trans score has not changed since the date given in the If-Modified-Since HTTP header.

404

An trans score with the specified trans score 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"
    }
  ]
}

Loading...