CreateBeneficiaryResponse
Response for `POST /v1/beneficiaries`, with the beneficiary under `data`. Returns `201` when it creates a new record, and `200` when it reactivates an archived account with the same `account_number`: There `meta.reactivated` comes back `true`.
Properties
| Field | Type | Description |
|---|---|---|
data | object | 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 | Numeric identifier of the beneficiary in the system. |
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 | SPEI code (5 digits) of the resolved bank. It is the empty string (`""`) when the account has no known bank: a card whose BIN is not in the directory. In that case `bank_name` carries a placeholder text in the language of the request. |
bank_name* | string | Official name of the bank, resolved from its `bank_code`. With an empty `bank_code` it is a placeholder text ("Unrecognized BIN (411111)"), translated into the language of the request. |
label | string | null | User-assigned descriptive label. `null` when not provided. |
status* | string | Beneficiary status. `inactive` if the beneficiary was archived. `active` if it is in use. |
created_at* | string (date-time) | Date and time, in ISO 8601 UTC, of creation. |
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 the `meta` block of every response (and in the `meta` of outgoing webhook bodies). 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
POST /v1/beneficiaries