CARD-CASH operation import - no transaction monitoring
Just so you know, further examples and descriptions apply only to CARD-CASH operation imports without transaction monitoring.
This section provides information how to submit operation (transaction) details to our database and is focused to those operations which don’t require to perform transaction monitoring.
It includes examples of API requests with mandatory and optional fields, a comprehensive list of all available fields, common responses and error descriptions.CARD-CASH operation is a simple cash withdrawal from ATM. So in this case note that:DEBTOR - is an entityCREDITOR - is an ATM.HTTP Method:POSTPath:{{baseUrl}}/amlyze-ws-rest/operationContentType:application/jsonAuthorization:Bearer Token
❗Mandatory field for clients utilizing a multi-organizational solution. Omit this parameter unless instructed about it.It serves to specify the unique identifier for the business unit. Business units are logical groupings of users and data. Each business unit can have its own set of users, permissions, and data access rules.Example:BUSINESS_UNIT_NAME
The role of the party in ongoing operation. At least one operation party account must already exist in Amlyze.Only one operation can be imported per API request which means only one CREDITOR and one DEBTOR could be provided.Enum class values:DEBTOR, CREDITOR, ULTIMATE_DEBTOR, ULTIMATE_CREDITORIf financialFlowDirection is INCOMING your customer is CREDITOR.
If financialFlowDirection is OUTGOING your customer is DEBTOR.Example:CREDITOR
❗Not mandatory if partyRole is ULTIMATE_DEBTOR or ULTIMATE_CREDITOR.Unique account identification number used in performing operations.Example:LT038625979279192518
❗Not mandatory if entity is INDIVIDUAL and both firstName and
lastName are provided.Identifies a party (INDIVIDUAL, ORGANIZATION or UNKNOWN) without requiring firstName or lastName.Example:Moller
❗Mandatory only when “partyRole” = “ULTIMATE_” and no more elements are provided for that party.Unique identification number (e.g., personal ID, company VAT code) to distinguish the payer and the transaction. Can be used for customer, counterparty and ultimateparty.Example:50007153359
This part lists common responses after the submission of the request.
Copy
200 OK "resultType": "REQUEST_ACCEPTED"400 Bad Request "resultType": "REQUEST_REJECTED", "errorCode": "O001", "errorDescription": "CommunicationNumber already used in amlyze"404 Not Found "timestamp": "2024-05-26T16:49:50.237+00:00", "status": 404, "error": "Not Found", "path": "/amlyze-ws-rest/opeation" --> mistake inside the endpoint500 Internal Server Error "resultType": "REQUEST_REJECTED" "status": 500, "error": "Internal Server Error"
This section lists the possible errors that can occur when making a bad operation request to the API. A bad request is a request that somehow does not follow the API specifications.
Error Description
DestinationCountry is mandatory, check country classifier codes for allowed values.
Amount is mandatory and must be greater than 0.
Despite currency = EUR, AmountInEur differs from Amount.
AmountInEur is mandatory and must be greater than 0.
EuroExchangeRate is mandatory and must be greater than 0.
For non-INTERNAL operation, financialFlowDirection value cannot be ‘NULL’.
Description is mandatory.
Invalid MerchantCountryCode.
RiskManagementCategory is mandatory.
RiskManagementCategory does not exist in Amlyze.
RiskManagementCategory does not support Operation.
Account registered to your institution; Account found in Amlyze, but customer not found in Amlyze.
entityType mismatch in operationParty[” + i + ”]: Amlyze customer has different entity type to operation one.
For INCOMING operation, your customer party role must be CREDITOR.
For OUTGOING operation, your customer party role must be DEBTOR.
operationType ” + operationType.getCode() + ” is not defined in Amlyze. Check Operation type classifier for available values.
Problem with operation party (index: ” + i + ”).
Invalid FinancialFlowDirection: Your institution DEBTOR found for INCOMING operation.
Invalid FinancialFlowDirection: Your institution CREDITOR found for OUTGOING operation.
OperationParties must contain CREDITOR.
OperationParties must contain DEBTOR.
Invalid operation party count. Range: min 1, max 4.
Invalid count of operation parties for ” + operationType.getCode() + ” operationType.
For ‘PIS’ operation, only creditor can be provided.
No operation party account related to your institution BIC, or Customer.
Invalid count of your institution operation parties for ” + operationType.getCode() + ” operationType.
Tenant header ’” + securityOwnerService.getHeaderTenantCode() + ”’ is mandatory.
Business unit is mandatory.
Tenant ’” + tenantCode + ”’ business unit ’”+ businessUnitCode +”’ does not exist.
CommunicationNumber is mandatory.
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.
SourceCountry is mandatory, check country classifier codes for allowed values.
Problem with OperationType (SEPA): Problem with OperationParties. No operation party account related to your institution BIC or Customer.
Problem with OperationType (SEPA): Invalid count of your institution operation parties for SEPA operationType.