LookupBeneficiaryAccountResponse
Response from `GET /v1/beneficiaries/lookup?account=`. Returns the beneficiary metadata when the exact account number exists in the authenticated user's whitelist.
Properties
| Field | Type | Description |
|---|---|---|
type * | string | JSON:API resource type. |
attributes * | object | Resolved account metadata. |
account_number * | string | Queried account number (CLABE, card, or phone). |
account_type * | string | Account type auto-detected at registration. |
bank_code * | string | 5-digit Banxico SPEI code of the receiving bank. |
bank_name * | string | Resolved bank name. |
label | string | null | Free-form label, `null` if none was assigned. |
Variants
allOf
-
SuccessEnvelope -
object
Used in operations
GET /v1/beneficiaries/lookup