v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Transaction Management Endpoints

account/transactions/cancel

This endpoint allows a recently created transaction to be cancelled. Once a transaction has begun being processed it can no longer be canceled through this endpoint.

Paylink can also be cancelled using this endpoint and can only be cancelled if it is in a pending status. Once the paylink is cancelled successfully, the cancellation email will be sent to the recipient as a cancellation confirmation.

post/account/transactions/cancel

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

TransactionIDinteger required

The unique ID for the transaction

TransactionStatusstring required

A message indicating the current transaction status - cancelled

Timestampstring date-time required

The timestamp when the transaction status was last modified

Example response

{
  "Success": true,
  "TransactionStatus": "cancelled",
  "Timestamp": "2019-11-26 12:00:00"
}