ListBeneficiariesResponse
Response from `GET /v1/beneficiaries`. Contains a flat array (no pagination) with all beneficiary accounts for the authenticated user. The tri-state `?with_archived` query parameter controls whether archived accounts are included.
Properties
| Field | Type | Description |
|---|---|---|
data | array | Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`). |
type* | string | JSON:API resource type. Always `beneficiary`. |
id* | string | Auto-increment numeric identifier of the beneficiary in the `user_beneficiaries` table. |
attributes* | object | Canonical beneficiary attributes (recipient account data and record metadata). |
account_number* | string | Stored account number: 18-digit CLABE, 16-digit card, or 10-digit DiMo phone. Use `account_type` to disambiguate the exact type. |
account_type* | string | Auto-detected account type: `clabe` (18 digits), `card` (16 digits), or `phone` (10 digits, DiMo mobile). |
bank_code* | string | 5-digit Banxico code of the receiving bank, derived from the CLABE prefix, card BIN, or DiMo catalog. |
bank_name* | string | Bank name resolved from the CLABE prefix, card BIN, or DiMo catalog. |
label | string | null | User-assigned descriptive label. `null` if not provided. |
status* | string | Beneficiary status. `inactive` is set when the beneficiary is archived (excluded from default listings). `active` — in use; `inactive` — retired without being deleted. |
created_at* | string (date-time) | UTC creation timestamp. |
meta | object | Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC. |
version | string | API version that processed the request. |
api_version | string | API route prefix version (e.g. `v1`). |
request_id | string | Unique request identifier (hex). |
datetime | object | Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec. |
timezone* | string | Always `UTC` — the canonical timezone for every datetime field in the body. |
format* | string | Always `ISO 8601` — explicit `Z` suffix on every datetime. |
links | object | Pagination or related links, present only when the endpoint returns a paginated collection. |
Used in operations
GET /v1/beneficiaries