Get Recent Payees

Retrieves a list of recently used payees associated with the authenticated user's account.

Get Recent Payees

This endpoint returns a list of payees that the authenticated user has recently paid or transferred funds to. The response enables banking applications to present quick-select options in payment and transfer flows, reducing friction for repeat transactions. Results are ordered by most recent payment date so the most frequently accessed payees appear first.

Endpoint

GET /recentPayees

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 to populate a recent-payees list or suggestion dropdown in the payment or transfer section of your application. It allows users to quickly select a previously paid recipient without re-entering payee details. This is particularly useful for business customers who make frequent recurring transfers to the same counterparties.

Response

200 OK

FieldTypeDescription
financialAccountIdstring (nullable)Unique identifier for the payee's financial account on the Netevia platform
doingBusinessNamestring (nullable)The business or display name of the payee
businessPhoneNumberstring (nullable)Contact phone number associated with the payee's business account
webSitestring (nullable)Website URL associated with the payee's business profile
accountNumberLast4string (nullable)Last 4 digits of the payee's account number, used for display and confirmation
fullAccountNumberstring (nullable)Full account number of the payee; treat as sensitive and mask in UI as XXXXXXXXXX
[
  {
    "financialAccountId": "fa_a1b2c3d4e5f6",
    "doingBusinessName": "Acme Supplies LLC",
    "businessPhoneNumber": "+13055550101",
    "webSite": "https://acmesupplies.example.com",
    "accountNumberLast4": "4321",
    "fullAccountNumber": "XXXXXXXXXX"
  },
  {
    "financialAccountId": "fa_z9y8x7w6v5u4",
    "doingBusinessName": "Metro Logistics Inc",
    "businessPhoneNumber": "+13055550188",
    "webSite": null,
    "accountNumberLast4": "8876",
    "fullAccountNumber": "XXXXXXXXXX"
  }
]

Error Codes

CodeWhen it happens
401Token missing, expired, or invalid
500Internal server error while retrieving recent payees

Common Mistakes

  • Displaying the fullAccountNumber field in plain text in the UI; always mask it as XXXXXXXXXX to comply with security requirements.
  • Calling this endpoint without a valid Bearer token — ensure the token has not expired (10-minute lifetime) and refresh it via POST /api/auth/refresh before retrying.
  • Assuming the list is always non-empty; handle the case where the array is empty (no prior payment history for the user).

Related Endpoints

  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an existing Bearer token
  • GET /search — Search for Netevia customers or payees by name or account details

Example

curl -X GET https://api.banking.netevia.dev/recentPayees \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json