Reference · Payees
List payees
GET
https://api.paygoro.com/v1/payeesLists saved beneficiaries, alphabetically by name.
Authorization
Requires a bearer API key with payees:read. See Authentication.
Query parameters
| Name | Type | Description |
|---|---|---|
companyId | string | Restrict to one legal entity. Omit to include every entity in the workspace. |
Response
200 · application/json
| Field | Type | Description |
|---|---|---|
data | array of object | |
id | string | Opaque resource id. |
companyId | string | Opaque resource id. |
name | string | max 70 chars |
iban | string | Normalized IBAN (uppercase, no spaces). |
defaultReference | string | null | |
lastUsedAt | string (date-time) | null | When a transfer to this payee was last initiated. |
createdAt | string (date-time) | Timestamp in RFC 3339 format (UTC). |
updatedAt | string (date-time) | Timestamp in RFC 3339 format (UTC). |
Errors
| 400 | BAD_REQUEST | The request was malformed or failed validation. |
| 401 | UNAUTHORIZED | Missing, malformed, expired or revoked API key. |
| 403 | FORBIDDEN | The API key does not have the scope this operation requires. |
| 404 | NOT_FOUND | No resource with this id exists in your workspace, or a `companyId` filter does not match one of your companies. |
| 429 | TOO_MANY_REQUESTS | Rate limit exceeded. Retry after the `Retry-After` header. |
All errors share one envelope — see Errors.