Zelle Endpoints

zelle/cancel

Cancel a pending Zelle withdrawal transaction. If the transaction has already been submitted to the processor, a cancellation request will be sent.

A transaction that cannot be cancelled responds with ErrorCode INVALID_ACTION. This covers a transaction whose status is not one of pending, waiting, pending approval or in progress - including one that is already cancelled - and one whose Zelle status shows the payment has already reached the network or is terminal.

post/zelle/cancel

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/zelle/cancel
  • 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 ID of the Zelle transaction to 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

TransactionIDstring required

ID of the cancelled transaction

TransactionStatusstring required

Updated status of the transaction

Example response

{
  "Success": true,
  "TransactionID": "123456",
  "TransactionStatus": "cancelled"
}

Changes

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