VOvopay
Vopay Instant Endpoints

rtr/withdraw/transaction/request-cancellation

This endpoint allows you to attempt to cancel an in progress Vopay Instant transaction. Note that the cancellation request will fail if the recipient has already deposited the funds.

A transaction in a state that can be neither cancelled nor have a cancellation requested (for example approved but not yet sent) is refused with ErrorCode INVALID_TRANSACTION_STATUS.

post/rtr/withdraw/transaction/request-cancellation

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/rtr/withdraw/transaction/request-cancellation
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

TransactionIDstring required

The unique ID for the transaction

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 - cancellation requested

Timestampstring date-time required

The timestamp when the transaction status was last modified

Example response

{
  "Success": true,
  "TransactionStatus": "cancellation requested",
  "Timestamp": "2022-11-26 12:00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.