Get Profile's Payees

The GET /netevia/payeeAccounts/{profileId} endpoint retrieves all payee accounts linked to a specific user profile within the Netevia Banking platform. It returns detailed information for each payee account, including the account name, masked account number, routing number, type, status, and creation date. This enables partners to present and manage a customer's saved payees for payment and transfer operations.

Endpoint

GET /netevia/payeeAccounts/{profileId}

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 when you need to display or verify the payee accounts saved under a customer's profile before initiating a payment or transfer. It is also useful for validating that a payee was successfully added or updated, or for building a payee management screen in your application. This endpoint supports both business and personal customer profiles.

Path Parameters

Response

200 OK

Returns an array of payee account objects. Each object has the following fields:

[
  {
    "id": "pye_a1b2c3d4e5f6",
    "type": "checking",
    "name": "Acme Supplies LLC",
    "created": "2025-11-14T10:23:00Z",
    "accountNumber": "XXXXXXXXXX",
    "routingNumber": "021000021",
    "status": "active"
  },
  {
    "id": "pye_f6e5d4c3b2a1",
    "type": "savings",
    "name": "John Smith",
    "created": "2026-01-05T08:45:00Z",
    "accountNumber": "XXXXXXXXXX",
    "routingNumber": "021000089",
    "status": "active"
  }
]

Error Codes

Common Mistakes

• Passing a non-integer or string value for profileId — the parameter must be a valid int32 numeric ID.
• Using an expired Bearer token — tokens are valid for 10 minutes; refresh via POST /api/auth/refresh before making this call.
• Expecting a single object in the response — the endpoint always returns an array, even if only one payee account exists.
• Not handling an empty array response — if the profile has no saved payees, the endpoint returns [] with a 200 status rather than a 404.

Related Endpoints

• POST /netevia/payeeAccounts — Add a new payee account to a profile
• DELETE /netevia/payeeAccounts/{payeeAccountId} — Remove a payee account
• GET /netevia/profile/{profileId} — Retrieve full profile details for a customer

Example

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