Zelle Endpoints

zelle/withdraw/decision

Approve or reject a Zelle payment that is in status 'pending decision'. A Zelle withdrawal enters 'pending decision' when the receiving bank flags that the recipient's registered name does not match the name provided. You know your end customer, so you decide: send Decision APPROVE and the payment continues (status returns to 'in progress'), or REJECT and the transaction fails and the funds are returned. A flag that is not answered may expire, in which case the payment fails.

A transaction that is not in status 'pending decision' responds with ErrorCode INVALID_ACTION and the message 'Transaction {TransactionID} is not pending decision.'

post/zelle/withdraw/decision

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/zelle/withdraw/decision
  • 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 in status 'pending decision'

Decisionstring required

Your decision on the flagged payment. APPROVE continues the payment; REJECT fails it and returns the funds. Accepted values: APPROVE, REJECT

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 transaction the decision was applied to

Decisionstring required

The decision that was submitted

Example response

{
  "Success": true,
  "TransactionID": "123456",
  "Decision": "APPROVE"
}

Changes

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