Product Area
CMPro / CPWeb
Problem
You want to submit payments that currently run outside CMPro / CPWeb, for example payouts from your own platform, directly through an interface, so that all payments go through the same approval logic.
The REST API of Alevate Payments is available for this. It transfers payment files to the system and returns account statement information.
Send payment files: optionally classified as confidential
Retrieve account statement information: for a given bank account identifier
Retrieve account statement transactions: for a given account statement identifier
Without a licence key entry, communication through the REST API is not possible. The endpoints are reachable only for an authenticated user account.
Solution Steps
Have it checked whether a licence key entry for REST API communication exists for your system. If it is missing, contact your Serrala contact person; the licence costs are clarified there.
Use a user account that holds the privilege to use API communication. Every request to the endpoints requires such an account.
Go to System data – Path Monitoring and create a new path monitoring of the type API Monitoring. The user needs the privilege to create and edit path monitoring configuration settings.
Create a separate entry in the tab API Monitoring for every payment format.
Set the parameter SystemId as the identifier of the source system. Together with the parameter format, the system uses it to map incoming payment files to the configured setting.
Run the communication over HTTPS. The REST API fully supports https encryption.
Set the confidential flag when you send sensitive payment files. A default permission profile is attached to these payment orders, so that only users with the corresponding privileges can work with them.
Result:
Payments from the source system are submitted through the REST API and go through the same approval logic as the other payments.
A unique tracking identifier is returned for every payment that was received successfully; it can be displayed in the system and allows the payment to be traced in both systems.
The processing status can be followed through the state tracking of the transfer orders.
Known Limitations
A user account with the privilege to use API communication is able to read data from all accounts. Take this into account when you assign the privilege.
If the path monitoring service is temporarily down, the files that pile up in the inbox are picked up after the restart and processed in the order in which they were received.
The technical description of the endpoints, including the request and response format, is part of the API documentation. You receive it from Serrala Product Support.