Get List of Payees

The Get Payees endpoint returns all payees linked to the authenticated user's account. Each payee record includes identifying details such as name, account number, routing number, and account type, enabling partners to display and manage payee information for ACH and funds movement workflows.

Endpoint

GET /api/fundsMovement/Payees

Authentication

Bearer token required. Obtain via:

POST https://api.banking.netevia.dev/api/auth/v2

Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.

When to use

Use this endpoint before initiating an ACH transfer to let a user select a destination payee from their saved list. It is also useful for building payee management UIs where customers can review, update, or remove existing payees prior to scheduling or batch transfers.

Response

200 OK

The response contains a payees array. Each element in the array is a payee object with the following fields:

{
  "payees": [
    {
      "id": "payee_abc123",
      "name": "Acme Supplies LLC",
      "createdAt": "2025-03-10T14:22:00Z",
      "updatedAt": "2025-05-01T09:15:00Z",
      "accountNumber": "XXXXXXXXXX",
      "routingNumber": "021000021",
      "last4": "4321",
      "type": "CHECKING",
      "typename": "Checking"
    },
    {
      "id": "payee_def456",
      "name": "Jane Smith",
      "createdAt": "2025-01-20T08:00:00Z",
      "updatedAt": null,
      "accountNumber": "XXXXXXXXXX",
      "routingNumber": "322271627",
      "last4": "7890",
      "type": "SAVINGS",
      "typename": "Savings"
    }
  ]
}

Error Codes

Common Mistakes

• Sending the request without an Authorization header causes a 401; always include Bearer {token}.
• The token expires after 10 minutes — call POST /api/auth/refresh to obtain a new token before the expiry to avoid interruptions in payee listing flows.
• accountNumber contains the full account number; avoid logging or displaying this value in full. Use last4 for display purposes in the UI.
• An empty payees array (not a 404) is returned when the account exists but has no saved payees; handle this case in your integration.

Related Endpoints

• POST /api/fundsMovement/Payees — Add a new payee to the account
• DELETE /api/fundsMovement/Payees/{payeeId} — Remove a payee from the account
• POST /api/fundsMovement/ACH — Initiate an ACH transfer to a saved payee
• GET /api/fundsMovement/Transfers — Retrieve transfer history

Example

curl -X GET https://api.banking.netevia.dev/api/fundsMovement/Payees \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"