Zelle Endpoints

zelle/recipients

List saved Zelle recipients for the account. Recipients are automatically saved when a Zelle payment is submitted.

get/zelle/recipients

Request

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

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

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

NumberOfRecordsinteger required

Total number of recipients returned

Example response

{
  "Success": true,
  "Recipients": {
    "0": {
      "RecipientName": "John Smith",
      "AliasType": "EMAIL",
      "AliasValue": "john.smith@example.com",
      "ZelleToken": "a1b2c3d4e5f6"
    }
  }
}

Changes

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