Create transaction score

POST 
/TransactionScores

Create transaction score

Request

application/json

Body

Trans Score to create.

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.

Responses

201

trans score was created.

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"
}

400

trans score is invalid.

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

Incorrect JSON format.

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"
    }
  ]
}

409

trans score already exists.

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...