This API deletes the specified predefined transfers, therefore returning the number of the transfers that were "effectively" deleted. For example, if you try to delete 10 transfers, and only 1 exists, it returns an answer with the number 1.
If you need additional details, see → Transfer alert service.
Authentication phase
Before using the endpoint, you must run the authentication phase (→ Login).
After the authentication, a session opens and a valid session token persists until:
- The end of the session time-out, that is set through the parameter sessionTimeout (→ OptimaWSI configuration > OptimaAuth section).
- An explicit Logout call (→ Logout).
Request endpoint
Request
DEL
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/predefined/
Request parameters
| Parameter | Required | Description |
|---|---|---|
|
transferId |
NO |
ID of a transfer to be deleted. You can also specify a list of n events, in the format: transferId=ID1&transferId=ID2&...&transferId=IDn. Important: IDs are not self-generated by the system, but are set through the API (→ Creating transfers). |
Request content-type
Not applicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
The processing request has been accepted. |
Response content-type
text/plain
Response output
Deleted <number of deleted transfers> predefined transfers.
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/predefined?transfer_id=1&transfer_id=2
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
The processing request has been accepted. |
Response output
Deleted 1 predefined transfers.