Toku

Toku Beneficiary Accounts API

Consulta y mantención de las Beneficiary Accounts: las cuentas bancarias asociadas a un Beneficiary, junto con su verificación bancaria y su flujo de aprobación.

Documentation GitHub OpenAPI

Operations 3

GET /payouts-beneficiary/beneficiary-account/by-batch/{id_beneficiary_batch} Listar verificaciones de Beneficiary Accounts por lote #

PATCH /payouts-beneficiary/beneficiary-account/{id_beneficiary_account}/account-data Actualizar datos bancarios de Beneficiary Account #

PATCH /payouts-beneficiary/beneficiary-account/{id_beneficiary_account}/external-id Actualizar external_id de Beneficiary Account #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/toku/openapi/toku-beneficiary-accounts-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/toku/json-schema/toku-public-checkout-session-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/toku/json-schema/toku-created-checkout-session-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/toku/json-schema/toku-webhook-endpoint-schema.json

📊

JSONSchema

https://artifacts.apis.io/toku/json-schema/toku-update-webhook-endpoint-payload-schema.json

📊

JSONSchema

https://artifacts.apis.io/toku/json-schema/toku-webhook-endpoint-payload-schema.json

📊

JSONSchema

https://artifacts.apis.io/toku/json-schema/toku-checkout-session-request-v2-decryption-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/toku:toku-beneficiary-accounts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Recursos secundarios Beneficiary Accounts API
  version: 1.0.0
  description: 'Consulta y mantención de las Beneficiary Accounts: las cuentas bancarias asociadas a un Beneficiary, junto con su verificación bancaria y su flujo de aprobación.'
servers:
- description: Production
  url: https://api.trytoku.com
security:
- ApiKeyAuth: []
tags:
- description: 'Consulta y mantención de las Beneficiary Accounts: las cuentas bancarias asociadas a un Beneficiary, junto con su verificación bancaria y su flujo de aprobación.'
  name: Beneficiary Accounts
paths:
  /payouts-beneficiary/beneficiary-account/by-batch/{id_beneficiary_batch}:
    get:
      description: 'Lista el resultado de la verificación bancaria de todas las Beneficiary Accounts cuyo Beneficiary fue creado en un mismo lote.


        El identificador de lote es el `id_beneficiary_batch` que devuelve la creación masiva de Beneficiaries, de modo que esta operación permite seguir el avance de una carga completa sin consultar cuenta por cuenta. Cada elemento informa el estado de la verificación y, cuando corresponde, la razón por la que quedó inválida.


        La respuesta viene paginada mediante `page` y `limit`, e incluye el total de verificaciones del lote en `total_count`.


        **Límite de tasa:** 1000 solicitudes por hora. Al superarlo, la API responde `429`. Ver Límites de tasa.'
      operationId: get_account_verifications_by_batch
      parameters:
      - description: Identificador del lote devuelto por la creación masiva de Beneficiaries.
        in: path
        name: id_beneficiary_batch
        required: true
        schema:
          description: Identificador del lote devuelto por la creación masiva de Beneficiaries.
          format: uuid
          title: Id Beneficiary Batch
          type: string
      - description: Número de página que se quiere obtener; la primera es la 1.
        in: query
        name: page
        required: false
        schema:
          default: 1
          description: Número de página que se quiere obtener; la primera es la 1.
          minimum: 1
          title: Page
          type: integer
      - description: Cantidad máxima de elementos por página.
        in: query
        name: limit
        required: false
        schema:
          default: 1000
          description: Cantidad máxima de elementos por página.
          minimum: 1
          title: Limit
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryAccountsVerificationsByBatchResponse'
          description: Página de verificaciones del lote, con el total de verificaciones.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutsBeneficiaryService_ErrorResponse'
          description: Error inesperado al procesar la solicitud.
      summary: Listar verificaciones de Beneficiary Accounts por lote
      tags:
      - Beneficiary Accounts
  /payouts-beneficiary/beneficiary-account/{id_beneficiary_account}/account-data:
    patch:
      description: 'Reemplaza los datos bancarios de una Beneficiary Account: número de cuenta, código de banco y tipo de cuenta.


        La operación reemplaza el bloque completo, no fusiona campo a campo. El número y el tipo de cuenta son obligatorios; el código de banco solo se usa en los países cuyo número de cuenta no lo lleva, y en esos es obligatorio: en México se ignora y se toma de los tres primeros dígitos de la CLABE, y por eso una CLABE con formato inválido se rechaza con `422`.


        Si la cuenta ya estaba verificada, el cambio la devuelve a `PENDING_VERIFICATION` y deja la nueva cuenta bancaria en cola para verificarse, porque lo verificado antes ya no corresponde a los datos vigentes.


        **Límite de tasa:** 1000 solicitudes por hora. Al superarlo, la API responde `429`. Ver Límites de tasa.'
      operationId: patch_beneficiary_account_data
      parameters:
      - description: Identificador de la Beneficiary Account.
        in: path
        name: id_beneficiary_account
        required: true
        schema:
          description: Identificador de la Beneficiary Account.
          format: uuid
          title: Id Beneficiary Account
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBeneficiaryAccountDataPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchBeneficiaryAccountResponse'
          description: La cuenta con sus datos bancarios actualizados.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: No existe una Beneficiary Account con ese identificador.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutsBeneficiaryService_ErrorResponse'
          description: Ya existe otra Beneficiary Account con esos datos bancarios.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutsBeneficiaryService_ErrorResponse'
          description: El cuerpo de la solicitud no cumple el formato esperado.
      summary: Actualizar datos bancarios de Beneficiary Account
      tags:
      - Beneficiary Accounts
  /payouts-beneficiary/beneficiary-account/{id_beneficiary_account}/external-id:
    patch:
      description: 'Cambia únicamente el `external_id` de una Beneficiary Account, el identificador con que la cuenta se conoce en el sistema de origen.


        Se usa cuando la cuenta se creó en Toku antes de existir en el sistema de origen y hay que enlazarlas después. El `external_id` debe ser único entre las cuentas de la Organization: reutilizar uno existente responde `409`.


        No toca los datos bancarios ni la verificación de la cuenta, así que no dispara una nueva verificación.


        **Límite de tasa:** 1000 solicitudes por hora. Al superarlo, la API responde `429`. Ver Límites de tasa.'
      operationId: patch_beneficiary_account_external_id
      parameters:
      - description: Identificador de la Beneficiary Account.
        in: path
        name: id_beneficiary_account
        required: true
        schema:
          description: Identificador de la Beneficiary Account.
          format: uuid
          title: Id Beneficiary Account
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchBeneficiaryAccountExternalIdPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchBeneficiaryAccountResponse'
          description: La cuenta con su nuevo external_id.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: No existe una Beneficiary Account con ese identificador.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutsBeneficiaryService_ErrorResponse'
          description: Ya existe otra Beneficiary Account con ese `external_id`.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutsBeneficiaryService_ErrorResponse'
          description: El cuerpo de la solicitud no cumple el formato esperado.
      summary: Actualizar external_id de Beneficiary Account
      tags:
      - Beneficiary Accounts
components:
  schemas:
    PayoutsBeneficiaryService_ErrorResponse:
      description: Error response model
      properties:
        detail:
          title: Detail
          type: string
      required:
      - detail
      title: PayoutsBeneficiaryService_ErrorResponse
      type: object
    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.
          examples:
          - '002010077777777771'
          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.
          examples:
          - '002'
          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.
          examples:
          - tok_5f3a90c17be24d8ab6c0e1f27d4a8395
          title: Tokenized Account Number
        type:
          allOf:
          - $ref: '#/components/schemas/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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    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.


        La 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
    PatchBeneficiaryAccountExternalIdPayload:
      description: Payload for PATCH external_id only (e.g. HDI flow).
      properties:
        external_id:
          description: Nuevo identificador de la cuenta en el sistema de origen.
          examples:
          - CTA-000123
          minLength: 1
          title: External Id
          type: string
      required:
      - external_id
      title: PatchBeneficiaryAccountExternalIdPayload
      type: object
    BeneficiaryAccountVerificationByBatchItem:
      description: El resultado de la verificación bancaria de una Beneficiary Account dentro de un lote.
      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.
          examples:
          - '002010077777777771'
          title: Account Number
        beneficiary_account_external_id:
          description: Identificador de la cuenta en el sistema de origen.
          examples:
          - CTA-000123
          title: Beneficiary Account External Id
          type: string
        beneficiary_external_id:
          description: Identificador del Beneficiary en el sistema de origen.
          examples:
          - PROV-000123
          title: Beneficiary External Id
          type: string
        beneficiary_name:
          description: Nombre del Beneficiary dueño de la cuenta.
          examples:
          - Comercializadora Andina
          title: Beneficiary Name
          type: string
        id_beneficiary:
          description: Identificador del Beneficiary dueño de la cuenta.
          examples:
          - 8c1d5e02-47ab-4f39-9d6c-2b0a7f4e1c83
          format: uuid
          title: Id Beneficiary
          type: string
        id_beneficiary_account:
          description: Identificador de la Beneficiary Account.
          examples:
          - 3f2a1c64-9b0e-4d7a-8f21-5c6b7e8d9a01
          format: uuid
          title: Id Beneficiary Account
          type: string
        invalid_reason:
          anyOf:
          - type: string
          - type: 'null'
          description: Motivo por el que la verificación quedó inválida; `null` cuando no lo está.
          examples:
          - DOCUMENT_MISMATCH
          title: Invalid Reason
        received_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Momento en que se recibió el resultado de la verificación.
          title: Received At
        requested_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Momento en que se solicitó la verificación.
          title: Requested At
        status:
          allOf:
          - $ref: '#/components/schemas/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.
        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.
          examples:
          - tok_5f3a90c17be24d8ab6c0e1f27d4a8395
          title: Tokenized Account Number
      required:
      - id_beneficiary_account
      - id_beneficiary
      - beneficiary_external_id
      - beneficiary_account_external_id
      - beneficiary_name
      - status
      title: BeneficiaryAccountVerificationByBatchItem
      type: object
    PatchBeneficiaryAccountResponse:
      description: 'Response for PATCH external-id and PATCH account-data: beneficiary name, bank details and external_id.'
      properties:
        beneficiary_name:
          description: Nombre del Beneficiary dueño de la cuenta.
          examples:
          - Comercializadora Andina
          title: Beneficiary Name
          type: string
        details:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryAccountBankDetailsResponse'
          description: Datos bancarios vigentes de la cuenta.
        external_id:
          description: Identificador de la cuenta en el sistema de origen.
          examples:
          - CTA-000123
          title: External Id
          type: string
      required:
      - beneficiary_name
      - details
      - external_id
      title: PatchBeneficiaryAccountResponse
      type: object
    BeneficiaryAccountsVerificationsByBatchResponse:
      properties:
        total_count:
          default: 0
          description: Total de verificaciones del lote, no solo las de esta página.
          examples:
          - 42
          title: Total Count
          type: integer
        verifications:
          description: Verificaciones de la página solicitada.
          items:
            $ref: '#/components/schemas/BeneficiaryAccountVerificationByBatchItem'
          title: Verifications
          type: array
      title: BeneficiaryAccountsVerificationsByBatchResponse
      type: object
    NotFoundResponse:
      description: Not found response model
      properties:
        detail:
          default: Resource not found
          title: Detail
          type: string
      title: NotFoundResponse
      type: object
    PatchBeneficiaryAccountDataPayload:
      description: Input payload for PATCH account data. ``bank_code`` is ignored for Mexico, where it is derived from the CLABE.
      properties:
        account_number:
          description: Nuevo número de la cuenta bancaria.
          examples:
          - '002010077777777771'
          minLength: 1
          title: Account Number
          type: string
        bank_code:
          anyOf:
          - minLength: 1
            type: string
          - type: 'null'
          description: 'Nuevo código del banco. Solo se usa en los países donde el número de cuenta no lo lleva, y en esos es obligatorio: en México se ignora, porque se toma de los tres primeros dígitos de la CLABE.'
          examples:
          - '002'
          title: Bank Code
        type:
          allOf:
          - $ref: '#/components/schemas/BeneficiaryAccountType'
          description: Nuevo tipo de cuenta bancaria.
      required:
      - account_number
      - type
      title: PatchBeneficiaryAccountDataPayload
      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
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Toku public API key. Send it in the x-api-key header on every request.
      in: header
      name: x-api-key
      type: apiKey
x-toku-api-version: '2026-10-08'
x-toku-dto-versions:
  DTOAccountPaymentInstrument: DTOAccountPaymentInstrumentV1
  DTOAggregatedPaymentMethod: DTOAggregatedPaymentMethodV2
  DTOAggregatedTransaction: DTOAggregatedTransactionV2
  DTOBankAccountPaymentMethod: DTOBankAccountPaymentMethodV1
  DTOBoletoPaymentInstrument: DTOBoletoPaymentInstrumentV2
  DTOBrPaymentInstrument: DTOBrPaymentInstrumentV2
  DTOCardPaymentInstrument: DTOCardPaymentInstrumentV1
  DTOCardPaymentMethod: DTOCardPaymentMethodV1
  DTOCashClPaymentInstrument: DTOCashClPaymentInstrumentV1
  DTOCashMxPaymentInstrument: DTOCashMxPaymentInstrumentV1
  DTOClPaymentInstrument: DTOClPaymentInstrumentV2
  DTOCustomer: DTOCustomerV2
  DTOInvoice: DTOInvoiceV4
  DTOMxPaymentInstrument: DTOMxPaymentInstrumentV3
  DTOPacManagementPaymentInstrument: DTOPacManagementPaymentInstrumentV1
  DTOPatpassPaymentInstrument: DTOPatpassPaymentInstrumentV1
  DTOPaymentIntent: DTOPaymentIntentV5
  DTOPaymentMethod: DTOPaymentMethodV7
  DTOPixPaymentInstrument: DTOPixPaymentInstrumentV1
  DTOPixPaymentMethod: DTOPixPaymentMethodV1
  DTOReferencedPaymentMXInstrument: DTOReferencedPaymentMXInstrumentV1
  DTOTransaction: DTOTransactionV10
  DTOTransferClPaymentInstrument: DTOTransferClPaymentInstrumentV2
  DTOTransferMxPaymentInstrument: DTOTransferMxPaymentInstrumentV1
  DTOUpdatedFields: DTOUpdatedFieldsV1
  DTOWalletMovement: DTOWalletMovementV1
  DTOWalletPaymentInstrument: DTOWalletPaymentInstrumentV2
x-toku-schema-names:
  ApiPaymentMethod_AssociatePaymentMethodResponse: AssociatePaymentMethodResponse
  ApiPaymentMethod_DTOPaymentMethodV7: PaymentMethod
  ApiPaymentTransaction_DTOTransactionV10: Transaction
  ApiPaymentTransaction_TransactionStatus: TransactionStatus
  ApiRenditionFile_BusinessDaysBeforeFilter: BusinessDaysBeforeFilter
  ApiRenditionFile_DaysBeforeFilter: DaysBeforeFilter
  ApiRenditionFile_DueDatesDaysFutureFilter: DueDatesDaysFutureFilter
  ApiRenditionFile_EntityRestrictions: EntityRestrictions
  ApiRenditionFile_NewestNInvoicesFilter: NewestNInvoicesFilter
  ApiRenditionFile_OldestNInvoicesFilter: OldestNInvoicesFilter
  CheckoutApi_AccountDetailsResponse: AccountDetailsResponse
  CheckoutApi_CheckoutSessionResponse: CheckoutSession
  ClientPaymentPortalBackend_CheckoutSessionResponse: CheckoutSessionResponse
  CollectionStrategist_InstitutionId: InstitutionId
  CollectionStrategist_SubTreeConfiguration: SubTreeConfiguration
  DTOAccountPaymentInstrumentV1: AccountPaymentInstrument
  DTOAggregatedTransactionV2: AggregatedTransaction
  DTOAppliedAdjustmentDocumentV1: AppliedAdjustmentDocument
  DTOBoletoPaymentInstrumentV2: BoletoPaymentInstrument
  DTOBrPaymentInstrumentV2: BrPaymentInstrument
  DTOCardPaymentInstrumentV1: CardPaymentInstrument
  DTOCardPaymentMethodV1: CardPaymentMethod
  DTOCashClPaymentInstrumentV1: CashClPaymentInstrument
  DTOCashMxPaymentInstrumentV1: CashMxPaymentInstrument
  DTOClPaymentInstrumentV2: ClPaymentInstrument
  DTOInvoiceV4: Invoice
  DTOMxPaymentInstrumentV3: MxPaymentInstrument
  DTOPacManagementPaymentInstrumentV1: PacManagementPaymentInstrument
  DTOPatpassPaymentInstrumentV1: PatpassPaymentInstrument
  DTOPaymentIntentV5: PaymentIntent
  DTOPixPaymentInstrumentV1: PixPaymentInstrument
  DTOPixPaymentMethodV1: PixPaymentMethod
  DTOReferencedPaymentMXInstrumentV1: ReferencedPaymentMXInstrument
  DTOTransferClPaymentInstrumentV2: TransferClPaymentInstrument
  DTOTransferMxPaymentInstrumentV1: TransferMxPaymentInstrument
  DTOUpdatedFieldsV1: UpdatedFields
  DTOWalletMovementV1: WalletMovement
  DTOWalletPaymentInstrumentV2: WalletPaymentInstrument
  GetCustomerResponse: Customer
  GetSubscriptionResponse: Subscription
  PayoutsBeneficiaryService_ApprovalFlowsStatus: ApprovalFlowsStatus
  PayoutsBeneficiaryService_Beneficiary: Beneficiary
  PayoutsBeneficiaryService_BeneficiaryAccount: BeneficiaryAccount
  PayoutsBeneficiaryService_BeneficiaryAccountVerification: BeneficiaryAccountVerification
  PayoutsBeneficiaryService_IdentityDocument: IdentityDocument
  PayoutsBeneficiaryService_VerificationStatus: VerificationStatus
  PayoutsDataIngestionService_DisbursementType: DisbursementType
  WebhookEndpointResponse: WebhookEndpoint
x-provenance:
  method: searched
  source: https://docs.trytoku.com/reference
  harvested: '2026-10-29'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.trytoku.com/reference/associate_subscription.md
  - https://docs.trytoku.com/reference/associate_subscription_bulk.md
  - https://docs.trytoku.com/reference/bulk_inscriptions_public.md
  - https://docs.trytoku.com/reference/cancel_billing_document.md
  - https://docs.trytoku.com/reference/cancel_preauth_endpoint.md
  - https://docs.trytoku.com/reference/capture_preauth_endpoint.md
  - https://docs.trytoku.com/reference/change_subscription_status.md
  - https://docs.trytoku.com/reference/create_adjustment_document.md
  - https://docs.trytoku.com/reference/create_beneficiaries.md
  - https://docs.trytoku.com/reference/create_bulk_automatic_debit_payment_methods.md
  - https://docs.trytoku.com/reference/create_credit_note.md
  - https://docs.trytoku.com/reference/create_customer.md
  - https://docs.trytoku.com/reference/create_customer_billing_data.md
  - https://docs.trytoku.com/reference/create_customer_billing_data_bulk.md
  - https://docs.trytoku.com/reference/create_document.md
  - https://docs.trytoku.com/reference/create_external_transaction.md
  - https://docs.trytoku.com/reference/create_external_transactions.md
  - https://docs.trytoku.com/reference/create_handler.md
  - https://docs.trytoku.com/reference/create_intent.md
  - https://docs.trytoku.com/reference/create_invoice_billing_data.md
  - https://docs.trytoku.com/reference/create_m2m_access_token.md
  - https://docs.trytoku.com/reference/create_or_update_invoice.md
  - https://docs.trytoku.com/reference/create_or_update_subscription.md
  - https://docs.trytoku.com/reference/create_pacs.md
  - https://docs.trytoku.com/reference/create_pix_automatic_configuration.md
  - https://docs.trytoku.com/reference/create_ppd_billing_document.md
  - https://docs.trytoku.com/reference/create_ppd_complement_billing_document.md
  - https://docs.trytoku.com/reference/create_ppd_complement_from_wallet_movement_billing_document.md
  - https://docs.trytoku.com/reference/create_public_validator_execution.md
  - https://docs.trytoku.com/reference/create_pue_billing_document.md
  - https://docs.trytoku.com/reference/create_receipt.md
  - https://docs.trytoku.com/reference/create_referenced_payment_mx_reference_endpoint.md
  - https://docs.trytoku.com/reference/create_terminal.md
  - https://docs.trytoku.com/reference/create_transfer_clabe_account.md
  - https://docs.trytoku.com/reference/create_webhook_endpoint.md
  - https://docs.trytoku.com/reference/delete_customer.md
  - https://docs.trytoku.com/reference/delete_customer_collection_account_endpoint.md
  - https://docs.trytoku.com/reference/delete_external_transaction.md
  - https://docs.trytoku.com/reference/delete_external_transactions.md
  - https://docs.trytoku.com/reference/delete_invoice.md
  - https://docs.trytoku.com/reference/delete_pacs.md
  - https://docs.trytoku.com/reference/delete_payment_method.md
  - https://docs.trytoku.com/reference/delete_subscription.md
  - https://docs.trytoku.com/reference/delete_terminal.md
  - https://docs.trytoku.com/reference/download_pdf_for_transaction.md
  - https://docs.trytoku.com/reference/edit_customer.md
  - https://docs.trytoku.com/reference/edit_invoice.md
  - https://docs.trytoku.com/reference/edit_invoice_billing_data.md
  - https://docs.trytoku.com/reference/edit_subscription.md
  - https://docs.trytoku.com/reference/edit_webhook_endpoint.md
  - https://docs.trytoku.com/reference/enroll_carteira_boleto.md
  - https://docs.trytoku.com/reference/expire_checkout_session_endpoint.md
  - https://docs.trytoku.com/reference/expire_handler.md
  - https://docs.trytoku.com/reference/expire_webhook_sender_organization_configuration_endpoint.md
  - https://docs.trytoku.com/reference/external_boleto_initialize.md
  - https://docs.trytoku.com/reference/external_onetime_initialize.md
  - https://docs.trytoku.com/reference/generate_report.md
  - https://docs.trytoku.com/reference/get_account_verifications_by_batch.md
  - https://docs.trytoku.com/reference/get_adjustment_document.md
  - https://docs.trytoku.com/reference/get_bank_account_verification_by_id.md
  - https://docs.trytoku.com/reference/get_bank_account_verifications.md
  - https://docs.trytoku.com/reference/get_beneficiary_accounts.md
  - https://docs.trytoku.com/reference/get_billing_document.md
  - https://docs.trytoku.com/reference/get_checkout_session_endpoint_v2.md
  - https://docs.trytoku.com/reference/get_customer.md
  - https://docs.trytoku.com/reference/get_customer_billing_data.md
  - https://docs.trytoku.com/reference/get_customer_collection_account_endpoint.md
  - https://docs.trytoku.com/reference/get_customers.md
  - https://docs.trytoku.com/reference/get_handler.md
  - https://docs.trytoku.com/reference/get_invoice.md
  - https://docs.trytoku.com/reference/get_invoice_billing_data.md
  - https://docs.trytoku.com/reference/get_paginated_chargeable_invoices.md
  - https://docs.trytoku.com/reference/get_payment_method.md
  - https://docs.trytoku.com/reference/get_payment_method_by_id.md
  - https://docs.trytoku.com/reference/get_payment_methods.md
  - https://docs.trytoku.com/reference/get_pix_automatic_configuration.md
  - https://docs.trytoku.com/reference/get_public_transactions.md
  - https://docs.trytoku.com/reference/get_receipt.md
  - https://docs.trytoku.com/reference/get_report_columns.md
  - https://docs.trytoku.com/reference/get_signed_document_url.md
  - https://docs.trytoku.com/reference/get_subscription.md
  - https://docs.trytoku.com/reference/get_subscriptions.md
  - https://docs.trytoku.com/reference/get_terminal.md
  - https://docs.trytoku.com/reference/get_transaction.md
  - https://docs.trytoku.com/reference/get_transaction_data_for_refund.md
  - https://docs.trytoku.com/reference/get_transaction_fees_public.md
  - https://docs.trytoku.com/reference/get_transfer_clabe_account.md
  - https://docs.trytoku.com/reference/get_webhook_endpoint.md
  - https://docs.trytoku.com/reference/get_webhook_endpoints.md
  - https://docs.trytoku.com/reference/get_webhook_sender_organization_configuration_endpoint.md
  - https://docs.trytoku.com/reference/ingest_payout_request_input.md
  - https://docs.trytoku.com/reference/initialize_enrollment_pix.md
  - https://docs.trytoku.com/reference/initialize_push_notification_enrollment.md
  - https://docs.trytoku.com/reference/list_adjustment_documents.md
  - https://docs.trytoku.com/reference/list_customer_invoices.md
  - https://docs.trytoku.com/reference/list_invoices.md
  - https://docs.trytoku.com/reference/list_invoices_by_customer.md
  - https://docs.trytoku.com/reference/list_payout_request_items.md
  - https://docs.trytoku.com/reference/list_payouts.md
  - https://docs.trytoku.com/reference/list_subject_consents.md
  - https://docs.trytoku.com/reference/list_terminals.md
  - https://docs.trytoku.com/reference/lookup_customer.md
  - https://docs.trytoku.com/reference/lookup_invoice.md
  - https://docs.trytoku.com/reference/lookup_subscription.md
  - https://docs.trytoku.com/reference/open_checkout_session_endpoint.md
  - https://docs.trytoku.com/reference/patch_beneficiary_account_data.md
  - https://docs.trytoku.com/reference/patch_beneficiary_account_external_id.md
  - https://docs.trytoku.com/reference/patch_beneficiary_metadata.md
  - https://docs.trytoku.com/reference/patch_webhook_sender_organization_configuration_endpoint.md
  - https://docs.trytoku.com/reference/pos_charge_endpoint.md
  - https://docs.trytoku.com/reference/post_customer_collection_account_endpoint.md
  - https://docs.trytoku.com/reference/post_webhook_sender_organization_configuration_endpoint.md
  - https://docs.trytoku.com/reference/public_available_institutions.md
  - https://docs.trytoku.com/reference/public_start_create_cash_mx_reference.md
  - https://docs.trytoku.com/reference/public_update_checkout_session_endpoint.md
  - https://docs.trytoku.com/reference/refund_invoice_public.md
  - https://docs.trytoku.com/reference/refund_transaction_public.md
  - https://docs.trytoku.com/reference/soft_delete_pix_automatic_configuration.md
  - https://docs.trytoku.com/reference/subscriptions_by_customer.md
  - https://docs.trytoku.com/reference/undo_debt_reconciliation_by_invoice_endpoint.md
  - https://docs.trytoku.com/reference/update_adjustment_document.md


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/toku/openapi/toku-beneficiary-accounts-api-openapi.yml