VOvopay
Transaction Management Endpoints

account/transaction/return

This endpoint allows you to return a transaction. A return can be initiated for EFT and ACH transactions that need to be returned (e.g., insufficient funds, account closed, or invalid account). The original transaction must be in a completed state to be returned.

post/account/transaction/return

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/transaction/return
  • 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

TransactionIDinteger required

The unique ID for the transaction to be returned

ReturnReasonstring

The reason for returning the transaction (e.g., insufficient funds, account closed)

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 return transaction

TransactionStatusstring

A message indicating the current transaction status

Example response

{
  "Success": true,
  "TransactionStatus": "returned"
}

Changes

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