v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Zelle Endpoints

zelle/recipients

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

get/zelle/recipients

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"
    }
  }
}