Create AML transaction type

POST 
/AmlTransTypes

Create AML transaction type

Request

application/json

Body

The AML transaction type to create.

transTypeId int32required

The numeric identifier of the transaction type.

transWithdrawDeposit int32nullablerequired

Indicates the transaction direction: withdrawal or deposit.

scoreBeneficiary booleanrequired

Indicates whether the beneficiary should be scored.

scoreOriginator booleanrequired

Indicates whether the originator should be scored.

scoreCarrier booleanrequired

Indicates whether the carrier should be scored.

returnZeroScore booleanrequired

Indicates whether a zero score should be returned when no rules match.

excludeFromAml booleanrequired

Indicates whether this transaction type is excluded from AML processing.

createdBy stringnullablerequired

The username or identifier of the user who created this record.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

Responses

201

The AML transaction type was created.

application/json

Schema

Schema

transTypeId int32required

The numeric identifier of the transaction type.

transWithdrawDeposit int32nullablerequired

Indicates the transaction direction: withdrawal or deposit.

scoreBeneficiary booleanrequired

Indicates whether the beneficiary should be scored.

scoreOriginator booleanrequired

Indicates whether the originator should be scored.

scoreCarrier booleanrequired

Indicates whether the carrier should be scored.

returnZeroScore booleanrequired

Indicates whether a zero score should be returned when no rules match.

excludeFromAml booleanrequired

Indicates whether this transaction type is excluded from AML processing.

createdBy stringnullablerequired

The username or identifier of the user who created this record.

updatedBy stringnullablerequired

The username or identifier of the user who last updated this record.

Example (from schema)

{
  "transTypeId": 0,
  "transWithdrawDeposit": 0,
  "scoreBeneficiary": true,
  "scoreOriginator": true,
  "scoreCarrier": true,
  "returnZeroScore": true,
  "excludeFromAml": true,
  "createdBy": "string",
  "updatedBy": "string"
}

400

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

404

A referenced resource 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"
    }
  ]
}

500

Internal server error.

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