Create transaction
POST/Transactions
Create transaction
Request​
- application/json
Body
Transaction to create.
The unique code identifying the transaction.
The document code associated with the transaction.
The code identifying the transaction type.
The numeric identifier of the transaction type.
The code of the branch where the transaction was processed.
The credit (incoming) amount of the transaction.
The debit (outgoing) amount of the transaction.
The commission fee charged for the transaction.
The ISO currency code of the transaction.
The exchange rate applied to the transaction.
The date and time when the transaction occurred.
The value date of the transaction (the date funds become available).
The availability date of the transaction funds.
The code of the channel through which the transaction was initiated.
The stated reason or purpose of the transaction.
The ISO country code of the transaction's country of origin.
The ISO country code of the country from which the transaction was sent.
The username of the operator who processed the transaction.
Indicates whether the transaction has been committed (finalized).
Indicates whether the transaction has been reversed.
The unique identifier of the beneficiary customer.
The beneficiary's last name.
The beneficiary's secondary last name.
The beneficiary's middle name.
The beneficiary's first name.
The IBAN of the beneficiary's account.
The current balance of the beneficiary's account.
The overdraft limit of the beneficiary's account.
The date of the last transaction on the beneficiary's account.
The unique identifier of the originator customer.
The originator's last name.
The originator's secondary last name.
The originator's middle name.
The originator's first name.
The IBAN of the originator's account.
The current balance of the originator's account.
The overdraft limit of the originator's account.
The date of the last transaction on the originator's account.
The unique identifier of the carrier (physical cash transporter).
The carrier's last name.
The carrier's secondary last name.
The carrier's middle name.
The carrier's first name.
The carrier's father's name.
The carrier's mother's name.
The carrier's mobile phone number.
The carrier's identity document number.
The code identifying the carrier's identity document type.
The carrier's tax identification number.
The carrier's home address.
The name of the carrier's home city.
The name of the carrier's home province.
The ISO country code of the carrier's home country.
The carrier's home telephone number.
Indicates whether the transaction should be scored by the AML engine.
Indicates whether the AML transaction record should be updated.
Indicates whether scoring details should be tracked for audit purposes.
Indicates whether an alert should be raised based on the scoring result.
Indicates whether the transaction involves physical cash.
createInfo object
Audit metadata capturing who created this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
Responses​
- 201
- 409
- 422
Transaction was created.
- application/json
- Schema
- Example (from schema)
Schema
The code of the transaction that triggered this alert.
The unique AML transaction identifier (UUID).
The unique code of the beneficiary customer.
The AML score computed for the beneficiary.
A summary of the rules applied to the beneficiary's score.
The unique code of the originator customer.
The AML score computed for the originator.
A summary of the rules applied to the originator's score.
The unique code of the carrier customer.
The AML score computed for the carrier.
A summary of the rules applied to the carrier's score.
{
"transactionCode": "string",
"amlTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"beneficiaryCustCode": "string",
"beneficiaryScore": 0,
"beneficiaryAppliedRules": "string",
"originatorCustCode": "string",
"originatorScore": 0,
"originatorAppliedRules": "string",
"carrierCustCode": "string",
"carrierScore": 0,
"carrierAppliedRules": "string"
}
Transaction already exists.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
reasons object[]nullable
The list of underlying error reasons.
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
The list of underlying error reasons.
The unique code identifying this entity.
errors object[]nullable
The list of validation errors.
The name of the field that failed validation.
The error or validation message.
{
"message": "string",
"metadata": {},
"reasons": [
{
"message": "string",
"metadata": {},
"reasons": [
null
]
}
],
"code": 0,
"errors": [
{
"field": "string",
"message": "string"
}
]
}
Unprocessable Entity.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
reasons object[]nullable
The list of underlying error reasons.
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
The list of underlying error reasons.
The unique code identifying this entity.
errors object[]nullable
The list of validation errors.
The name of the field that failed validation.
The error or validation message.
{
"message": "string",
"metadata": {},
"reasons": [
{
"message": "string",
"metadata": {},
"reasons": [
null
]
}
],
"code": 0,
"errors": [
{
"field": "string",
"message": "string"
}
]
}