Toku · Schema

BeneficiaryAccountByBeneficiaryResponse

Una Beneficiary Account vista desde el Beneficiary al que pertenece.

FintechPaymentsB2BAutomationChile

Properties

Name Type Description
approval_flows_status object Estado agregado del flujo de aprobación de la cuenta, independiente del estado de la verificación bancaria. Solo `APPROVED` —se reunieron todas las aprobaciones exigidas— y `SKIPPED` —ningún flujo de
currency_code string Moneda de la cuenta, en formato ISO.
details object Datos bancarios de la cuenta.
external_id object Identificador de la cuenta en el sistema de origen.
gateway_references object Identificador que la cuenta ya tiene en cada pasarela de pago, con el nombre de la pasarela como clave. Una cuenta de efectivo recibe el de OXXO Pay al darse de alta, y no se le puede pagar mientras n
id_beneficiary_account string Identificador de la Beneficiary Account.
verification object Estado de la verificación bancaria de la cuenta.
View JSON Schema on GitHub

JSON Schema

toku-beneficiary-account-by-beneficiary-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/toku/json-schema/toku-beneficiary-account-by-beneficiary-response-schema.json",
  "title": "BeneficiaryAccountByBeneficiaryResponse",
  "description": "Una Beneficiary Account vista desde el Beneficiary al que pertenece.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/toku-beneficiaries-api-openapi.yml#/components/schemas/BeneficiaryAccountByBeneficiaryResponse",
  "properties": {
    "approval_flows_status": {
      "allOf": [
        {
          "$ref": "#/$defs/ApprovalFlowsStatus"
        }
      ],
      "description": "Estado agregado del flujo de aprobación de la cuenta, independiente del estado de la verificación bancaria. Solo `APPROVED` —se reunieron todas las aprobaciones exigidas— y `SKIPPED` —ningún flujo de aprobación aplica a esta cuenta— la habilitan. Los otros tres bloquean: `PENDING` es que falta al menos una decisión, `REJECTED` que un aprobador la rechazó, e `INITIALIZING` que la evaluación inicial todavía no termina."
    },
    "currency_code": {
      "description": "Moneda de la cuenta, en formato ISO.",
      "title": "Currency Code",
      "type": "string"
    },
    "details": {
      "allOf": [
        {
          "$ref": "#/$defs/BeneficiaryAccountBankDetailsResponse"
        }
      ],
      "description": "Datos bancarios de la cuenta."
    },
    "external_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Identificador de la cuenta en el sistema de origen.",
      "title": "External Id"
    },
    "gateway_references": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Identificador que la cuenta ya tiene en cada pasarela de pago, con el nombre de la pasarela como clave. Una cuenta de efectivo recibe el de OXXO Pay al darse de alta, y no se le puede pagar mientras no lo tenga. Viene vacío en una cuenta bancaria.",
      "title": "Gateway References",
      "type": "object"
    },
    "id_beneficiary_account": {
      "description": "Identificador de la Beneficiary Account.",
      "format": "uuid",
      "title": "Id Beneficiary Account",
      "type": "string"
    },
    "verification": {
      "anyOf": [
        {
          "$ref": "#/$defs/BeneficiaryAccountByBeneficiaryVerification"
        },
        {
          "type": "null"
        }
      ],
      "description": "Estado de la verificación bancaria de la cuenta."
    }
  },
  "required": [
    "id_beneficiary_account",
    "external_id",
    "currency_code",
    "details",
    "approval_flows_status"
  ],
  "type": "object",
  "$defs": {
    "ApprovalFlowsStatus": {
      "description": "Aggregated approval status for a ``BeneficiaryAccount``.\n\n``INITIALIZING`` is a transient state set at creation time. Downstream consumers must treat ``INITIALIZING`` as blocking (same gating as ``PENDING``/``REJECTED``).",
      "enum": [
        "INITIALIZING",
        "APPROVED",
        "REJECTED",
        "PENDING",
        "SKIPPED"
      ],
      "title": "ApprovalFlowsStatus",
      "type": "string"
    },
    "BeneficiaryAccountBankDetailsResponse": {
      "description": "Bank/account details for PATCH responses.",
      "properties": {
        "account_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Número de la cuenta bancaria. Viene `null` en una cuenta de efectivo, que paga al beneficiario en efectivo y no tiene cuenta bancaria de destino.",
          "title": "Account Number"
        },
        "bank_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Código del banco donde está la cuenta. En México son los tres primeros dígitos de la CLABE, así que lo determina el número de cuenta. Viene `null` en una cuenta de efectivo, que no tiene cuenta bancaria de destino.",
          "title": "Bank Code"
        },
        "tokenized_account_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Token que reemplaza al número de cuenta cuando la cuenta ya fue tokenizada. Viene `null` mientras no lo esté y en una cuenta de efectivo, que no tiene número que tokenizar.",
          "title": "Tokenized Account Number"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/BeneficiaryAccountType"
            }
          ],
          "description": "Tipo de la cuenta de destino. Qué valores se aceptan depende del país de la cuenta: en Chile, `CHECKING_ACCOUNT` (cuenta corriente), `VISTA_ACCOUNT` (cuenta vista) y `SAVINGS_ACCOUNT` (cuenta de ahorro); en México, `BANK_ACCOUNT`, cuyo número de cuenta es una CLABE, y `CASH_ACCOUNT` (cuenta de efectivo), que paga al beneficiario en efectivo y por eso no tiene cuenta bancaria de destino. `DEBIT_CARD` quedó como valor heredado y hoy se rechaza en los dos países."
        }
      },
      "required": [
        "type"
      ],
      "title": "BeneficiaryAccountBankDetailsResponse",
      "type": "object"
    },
    "BeneficiaryAccountByBeneficiaryVerification": {
      "description": "Trimmed verification block for the accounts-by-beneficiary response.",
      "properties": {
        "invalid_reason": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Motivo por el que la verificación quedó inválida; `null` cuando no lo está.",
          "title": "Invalid Reason"
        },
        "status": {
          "allOf": [
            {
              "$ref": "#/$defs/VerificationStatus"
            }
          ],
          "description": "Estado de la verificación bancaria de la cuenta. Nace en `PENDING_VERIFICATION`, queda en `PROCESSING` mientras se espera el resultado, y termina en `VALIDATED`, que la habilita para recibir pagos, o en `INVALID`, que la deja rechazada. Editar los datos bancarios la devuelve a `PENDING_VERIFICATION` y reinicia el ciclo. La verificación automática hoy corre solo en México."
        }
      },
      "required": [
        "status"
      ],
      "title": "BeneficiaryAccountByBeneficiaryVerification",
      "type": "object"
    },
    "BeneficiaryAccountType": {
      "description": "Tipo de la cuenta de destino de un Beneficiary Account. Qué valores se aceptan depende del país de la cuenta: en Chile, `CHECKING_ACCOUNT` (cuenta corriente), `VISTA_ACCOUNT` (cuenta vista) y `SAVINGS_ACCOUNT` (cuenta de ahorro); en México, `BANK_ACCOUNT`, cuyo número de cuenta es una CLABE de 18 dígitos; `CIE_AGREEMENT`, un convenio CIE de BBVA de 7 dígitos; `INTERNATIONAL_ACCOUNT`, una cuenta internacional de 20 a 30 dígitos cuyo `bank_code` es el código ABA del banco, de 9 a 11 dígitos; `BBVA_ACCOUNT`, una cuenta BBVA de 10 u 11 dígitos; y `CASH_ACCOUNT` (cuenta de efectivo), que paga al beneficiario en efectivo y por eso no tiene cuenta bancaria de destino. `DEBIT_CARD` quedó como valor heredado y hoy se rechaza en los dos países.",
      "enum": [
        "BANK_ACCOUNT",
        "CASH_ACCOUNT",
        "DEBIT_CARD",
        "CIE_AGREEMENT",
        "INTERNATIONAL_ACCOUNT",
        "BBVA_ACCOUNT",
        "CHECKING_ACCOUNT",
        "VISTA_ACCOUNT",
        "SAVINGS_ACCOUNT"
      ],
      "title": "BeneficiaryAccountType",
      "type": "string"
    },
    "VerificationStatus": {
      "description": "Estado de la verificación bancaria de un Beneficiary Account. La cuenta nace en `PENDING_VERIFICATION`, queda en `PROCESSING` mientras se espera el resultado, y termina en `VALIDATED`, que la habilita para recibir pagos, o en `INVALID`, que la deja rechazada. Editar los datos bancarios la devuelve a `PENDING_VERIFICATION` y reinicia el ciclo.\n\nLa verificación automática hoy corre solo en México; en Chile la cuenta se queda en `PENDING_VERIFICATION` hasta que un operador la aprueba o rechaza.",
      "enum": [
        "PROCESSING",
        "VALIDATED",
        "INVALID",
        "PENDING_VERIFICATION"
      ],
      "title": "VerificationStatus",
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/toku-beneficiary-account-by-beneficiary-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.