Transaction Management Endpoints

account/transactions/refund

This endpoint allows you to refund a completed transaction (EFT, ACH, Interac, and credit card). The payment information provided in the original transaction is used in the refund.

post/account/transactions/refund

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/account/transactions/refund
  • 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 you want to refund

Amountnumber

The amount to refund. Value must be equal to or less than the original transaction amount. If no amount is provided, the full amount from the original transaction is used.

Notesstring

Optional notes to attach to the refund 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 refund transaction

InteracQuestionAnswerstring

The unique answer to the Interac question. Only applicable if refunding an Interac Money Request transaction.

Example response

{
  "Success": true,
  "InteracQuestionAnswer": "9sdai873rb"
}

Changes

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