Batch operation service

Validate batch of operations without saving

This method sends data only for validating JSON and does not create any data in Amlyze. HTTP Method: POST Path: {{baseUrl}}/amlyze-ws-rest/validate-batch-operations ContentType: application/json Authorization: Basic Auth/Bearer Token

Validate batch of operations with saving

This method sends data and creates data in Amlyze. HTTP Method: POST Path: {{baseUrl}}/amlyze-ws-rest/batch-operations ContentType: application/json Authorization: Basic Auth/Bearer Token ⚠️ Warning: Operations evaluation and screening not available in this service.

API requests example

Show Mandatory fields example | OPERATION import - BATCH

{
  "operations":[
    {
      "communicationNumber": "SepaComNumber0",
      "requester": "Company Name Amlyze",
      "riskManagementCategory": "OP_TRANSFER",
      "operationType": "SEPA",
      "operationStatus": "EXECUTED",
      "operationExtId": "SepaExtId0",
      "financialFlowDirection": "OUTGOING",
      "operationDateTime": "2023-09-23T15:09:33+02:00",
      "currency": "EUR",
      "amount": 10000,
      "description": "Invoice 'Nr.01'",
      "listOperationParty": [
        { 
          "partyRole": "DEBTOR", 
          "accountNumber": "LI9208800274335945522", 
          "bic": "AmlyzeXX22", 
          "entityType": "INDIVIDUAL", 
          "firstName": "Tomas", 
          "lastName": "Garcia" 
        },
        { 
          "partyRole": "CREDITOR", 
          "accountNumber": "LV11245541148212335", 
          "entityType": "ORGANIZATION", 
          "title": "LTD 'VivaFocus'" 
        }
      ]
    },
    {
      "communicationNumber": "SwiftComNumber0",
      "requester": "Company Name Amlyze",
      "riskManagementCategory": "OP_TRANSFER",
      "operationType": "SWIFT",
      "operationStatus": "EXECUTED",
      "operationExtId": "SwiftExtId0",
      "financialFlowDirection": "OUTGOING",
      "operationDateTime": "2023-09-23T15:09:33+02:00",
      "currency": "EUR",
      "amount": 100,
      "description": "Invoice 'Nr.02'",
      "listOperationParty": [
        { 
          "partyRole": "DEBTOR", 
          "accountNumber": "LI9208800274335945522", 
          "bic": "AmlyzeXX22", 
          "entityType": "INDIVIDUAL", 
          "firstName": "Tomas",
          "lastName": "Garcia"
        },
        { 
          "partyRole": "CREDITOR", 
          "accountNumber": "LV11245541148212335", 
          "entityType": "ORGANIZATION", 
          "title": "LTD 'VivaFocus'" 
        }
      ]
    }
  ]
}

Available operation types

SEPA operation SWIFT operation PIS operation INTERNAL operation CARD_PAYMENT operation CARD_CASH operation CASH incoming operation CASH outgoing operation CASH_TRANSFER operation FASTER_PAYMENTS operation CRYPTO operation CRYPTO_EXCHANGE operation

List of possible responses

200 OK
{
  "results": [
    {
      "resultType": "REQUEST_ACCEPTED",
      "communicationNumber": "SepaComNumber0",
      "operationExtId": "SepaExtId0",
      "businessUnit": "businessUnit0",
      "timeElapsedMs": 203
    },
    {
      "resultType": "REQUEST_ACCEPTED",
      "communicationNumber": "SwiftComNumber0",
      "operationExtId": "SwiftExtId0",
      "businessUnit": "businessUnit1",
      "timeElapsedMs": 203
    },
  ],
  "timeElapsedMs": 408
}

200 OK
{
  "results": [
    {
      "resultType": "REQUEST_ACCEPTED",
      "communicationNumber": "SepaComNumber0",
      "operationExtId": "SepaExtId0",
      "businessUnit": "businessUnit0",
      "timeElapsedMs": 203
    },
    {
      "resultType": "REQUEST_REJECTED",
      "communicationNumber": "SwiftComNumber0",
      "operationExtId": "SwiftExtId0",
      "businessUnit": "businessUnit1",
      "errorCode": "O005",
      "errorDescription": "Operation with given OperationExtId already exists in Amlyze",
      "timeElapsedMs": 20
    },
  ],
  "timeElapsedMs": 223
}

400 Bad Request (Invalid json body)
{
  "timestamp": "2024-05-26T16:49:50.237+00:00",
  "status": 400,
  "error": "Bad Request",
  "path": "/amlyze-ws-rest/batch-operations"
}

500 Internal Server Error
{
  "errorCode": "500",
  "errorDescription": "Processing failed",
  "timeElapsedMs": 172
}

List of possible errors

This section lists the possible errors that can occur when making a bad request to the API. A bad request is a request that somehow does not follow the API specifications.

Error Description
CommunicationNumber is mandatory
RiskManagementCategory is mandatory
RiskManagementCategory does not exist in amlyze
Requester is mandatory
SourceOfRiskLevel is mandatory, allowed values: IMPORT / EVALUATE
OperationExtId is mandatory
OperationType is mandatory
Problem with OperationType (INVALID). INVALID is not defined in Amlyze. Check Operation type classifier for available values
Currency is mandatory, check Currency classifier codes for allowed values
Currency is mandatory, check Currency classifier codes for allowed values
SourceCountry is mandatory, check country classifier codes for allowed values
DestinationCountry is mandatory, check country classifier codes for allowed values
Description is mandatory
Problem with OperationType (SEPA). Problem with OperationParties. No operation party account related to your institution BIC, or Customer
Invalid FinancialFlowDirection. Your institution CREDITOR found for OUTGOING operation
Problem with OperationType (SEPA). Problem with OperationParties. Invalid count of your institution operation parties for SEPA operationType

API Documentation

​Validate batch of operations without saving

​Validate batch of operations with saving

​API requests example

​Available operation types

​List of possible responses