VOvopay
Zelle Endpoints

zelle/withdraw/transaction

Retrieve details of a specific Zelle withdrawal transaction.

get/zelle/withdraw/transaction

Request

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

Query parameters

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 retrieve

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

Unique identifier for the transaction

TransactionDatestring required

Date and time the transaction was created

TransactionStatusstring required

Current status of the transaction, for example in progress, pending decision, successful, failed or cancelled

Amountstring required

Transaction amount formatted to 2 decimal places

RecipientNamestring required

Full name of the recipient

RecipientEmailstring required

Recipient's email alias, if used

RecipientPhonestring required

Recipient's mobile phone alias, if used

PriorityTypestring required

Payment priority type

Currencystring required

Currency of the transaction. Empty string if the Zelle transaction record is unavailable.

TransactionTypeCodestring required

Transaction type code for the underlying account transaction

GLCodestring required

General ledger code for the underlying account transaction

Notesstring required

Memo or note associated with the payment

ClientReferenceNumberstring required

Client reference number associated with the transaction

LastModifiedstring required

Date and time the transaction was last modified

Example response

{
  "Success": true,
  "TransactionID": "123456",
  "TransactionDate": "2024-01-15 10:30:00",
  "TransactionStatus": "in progress",
  "Amount": "100.00",
  "RecipientName": "John Smith",
  "RecipientEmail": "john.smith@example.com",
  "RecipientPhone": "+12065551234",
  "PriorityType": "STANDARD",
  "Currency": "USD",
  "TransactionTypeCode": "07090101",
  "Notes": "Invoice payment",
  "ClientReferenceNumber": "REF-001",
  "LastModified": "2024-01-15 10:35:00"
}

Changes

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