Overview and Request Content
- PDF
Overview and Request Content
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API is used to cancel an active EasySend digital transaction. The transaction could have been created by an integration, the Journey Sender or by organically opening a digital journey link in a browser.
URL Path
player/api/cancel-request
Method
A POST request should be performed with the following HTTP Header: Content-Type: application/json.
Authentication Using apiKey Field
The apiKey allows EasySend to use a simple authentication mechanism that is used to authenticate the client against the server. The apiKey must be passed with every API call.
Warning!
Your apiKey is private and should always be kept secret. Never share your API key with a 3rd party. Always trigger EasySend APIs from a server-side application. Avoid embedding your API key in a client-side / web-based application.
Request Content
Table 1 describes the required request content parameters.
Table 1: Request Content
| Parameter | Type | Optional/Required | Discerption |
| apiVersion | integer | Required | The API version |
| apiKey | string | Required | The API key for the provided environment |
| rid | string | Required | An rid of an active request, as returned from /generate-link |
Return Value
The HTTP status code will determine the success/failure of the response. The return code 200 is a success, and any other return code is considered an error.
Was this article helpful?