Cancel payment request

Introduction

The Cancel Payment Request API allows you to request the cancellation of a payment that has been initiated but not yet completed.

Authentication

Authentication is required to access this API. You'll need to provide an API key/token in the request headers.

API Endpoint

The cancel payment API endpoint is:

http://api-dev.accelerationcloud.com/api/v1/cores/money-movements/payments/{payment-id}/cancel

HTTP Method

Use the HTTP POST method to initiate a cancel payment request.

Request Headers

Include the following headers in your API request:

Authorization: Provide your API key/token for authentication.
Content-Type: Set this to application/json to indicate the request body format.

Request Body

The request body should be a JSON object with the following fields:

• payment_id (required): The unique identifier of the payment you want to cancel.
• reason (optional): A reason for the cancellation request.

Example request body:

{
  "payment_id": "123456789",
  "reason": "Customer requested cancellation"
}

Response Format

The response will be in JSON format and will include information about the cancellation request status.

Example response:

{
  "status": "success",
  "message": "Cancellation request received and is pending approval"
}

Error Handling

In case of errors, the response will include error information, such as error codes and messages. Refer to the Error Handling section in the Developer Portal for details on error codes and their meanings.

Rate Limits

The API has rate limits to prevent abuse