Toku POS Terminals API

openapi: 3.2.0
info:
  title: Recursos secundarios POS Terminals API
  version: 1.0.0
  description: 'Registro y administración de los terminales POS de la cuenta. Un terminal es el dispositivo físico donde se cobra, y queda asociado al adquirente con el que se registró: ese adquirente no se elige en cada cobro, sino que es una propiedad del dispositivo.'
servers:
- description: Production
  url: https://api.trytoku.com
security:
- ApiKeyAuth: []
tags:
- description: 'Registro y administración de los terminales POS de la cuenta. Un terminal es el dispositivo físico donde se cobra, y queda asociado al adquirente con el que se registró: ese adquirente no se elige en cada cobro, sino que es una propiedad del dispositivo.'
  name: POS Terminals
  x-toku-docs:
    category: chile
paths:
  /{country_code}/pos-terminals:
    get:
      description: 'Lista los terminales POS vigentes de la cuenta de las credenciales de la petición.


        Los terminales eliminados no aparecen.'
      operationId: list_terminals
      parameters:
      - description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
        in: path
        name: country_code
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/CountryCode'
          description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
      - description: Llave de API de una Account, para operar sobre esa Account en lugar de la principal.
        in: header
        name: x-account-key
        required: false
        schema:
          default: ''
          title: X-Account-Key
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PosTerminalListResponse'
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: Las credenciales no resuelven a una cuenta.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Listar los terminales POS
      tags:
      - POS Terminals
    post:
      description: 'Registra un terminal POS para la cuenta de las credenciales de la petición.


        El adquirente (`gateway`) queda fijo al registrarlo: los cobros que corran en ese dispositivo van a ese adquirente, sin elegirlo en cada venta. Cada adquirente exige sus propios datos (Getnet, por ejemplo, exige `acquirer_commerce_code` y `acquirer_branch_id`), y una petición sin ellos, o con un adquirente que no cobra por POS, se rechaza con 422.


        Un dispositivo ya registrado responde 409, nunca reutiliza el registro anterior. Si el terminal fue eliminado, se puede volver a registrar.'
      operationId: create_terminal
      parameters:
      - description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
        in: path
        name: country_code
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/CountryCode'
          description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
      - description: Llave de API de una Account, para operar sobre esa Account en lugar de la principal.
        in: header
        name: x-account-key
        required: false
        schema:
          default: ''
          title: X-Account-Key
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePosTerminalPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PosTerminalResponse'
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: Las credenciales no resuelven a una cuenta.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: Ya hay un terminal registrado con esos datos en el adquirente.
        '422':
          description: 'El adquirente no cobra por POS, o faltan los datos que exige: `detail` trae el texto que lo explica. Un cuerpo que no cumple el esquema responde el mismo estado con la lista de errores de validación en `detail`.'
      summary: Registrar un terminal POS
      tags:
      - POS Terminals
  /{country_code}/pos-terminals/{public_id_pos_terminal}:
    get:
      description: 'Obtiene un terminal POS de la cuenta de las credenciales de la petición.


        Un terminal de otra cuenta responde 404, igual que uno que no existe.'
      operationId: get_terminal
      parameters:
      - in: path
        name: public_id_pos_terminal
        required: true
        schema:
          title: Public Id Pos Terminal
          type: string
      - description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
        in: path
        name: country_code
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/CountryCode'
          description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
      - description: Llave de API de una Account, para operar sobre esa Account en lugar de la principal.
        in: header
        name: x-account-key
        required: false
        schema:
          default: ''
          title: X-Account-Key
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PosTerminalResponse'
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: Las credenciales no resuelven a una cuenta.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: No hay un terminal con ese id en la cuenta.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Obtener un terminal POS
      tags:
      - POS Terminals
    put:
      description: 'Actualiza los datos de un terminal POS de la cuenta de las credenciales de la petición.


        El cuerpo reemplaza por completo a los datos registrados: un campo que no se envía queda vacío. El adquirente y el tipo de dispositivo se declaran al registrarlo y no cambian acá; los datos que ese adquirente exige se siguen exigiendo, y una petición sin ellos se rechaza con 422.


        Dejar el terminal con los mismos datos que otro ya registrado responde 409.'
      operationId: update_terminal
      parameters:
      - in: path
        name: public_id_pos_terminal
        required: true
        schema:
          title: Public Id Pos Terminal
          type: string
      - description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
        in: path
        name: country_code
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/CountryCode'
          description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
      - description: Llave de API de una Account, para operar sobre esa Account en lugar de la principal.
        in: header
        name: x-account-key
        required: false
        schema:
          default: ''
          title: X-Account-Key
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePosTerminalPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PosTerminalResponse'
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: Las credenciales no resuelven a una cuenta.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: No hay un terminal con ese id en la cuenta.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: Ya hay un terminal registrado con esos datos en el adquirente.
        '422':
          description: 'El adquirente no cobra por POS, o faltan los datos que exige: `detail` trae el texto que lo explica. Un cuerpo que no cumple el esquema responde el mismo estado con la lista de errores de validación en `detail`.'
      summary: Actualizar un terminal POS
      tags:
      - POS Terminals
    delete:
      description: 'Elimina un terminal POS de la cuenta de las credenciales de la petición.


        El dispositivo deja de estar disponible para cobrar, y su id puede volver a registrarse después.'
      operationId: delete_terminal
      parameters:
      - in: path
        name: public_id_pos_terminal
        required: true
        schema:
          title: Public Id Pos Terminal
          type: string
      - description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
        in: path
        name: country_code
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/CountryCode'
          description: Código de país (ISO alpha-2 en minúsculas) que acota la operación.
      - description: Llave de API de una Account, para operar sobre esa Account en lugar de la principal.
        in: header
        name: x-account-key
        required: false
        schema:
          default: ''
          title: X-Account-Key
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletedPosTerminalResponse'
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: Las credenciales no resuelven a una cuenta.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiCards_ErrorDetailResponse'
          description: No hay un terminal con ese id en la cuenta.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Eliminar un terminal POS
      tags:
      - POS Terminals
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CountryCode:
      description: Códigos de país admitidos en el prefijo de ruta `/{country_code}`.
      enum:
      - cl
      - mx
      - br
      title: CountryCode
      type: string
    DeletedPosTerminalResponse:
      description: Terminal POS eliminado.
      properties:
        id_pos_terminal:
          description: Identificador del terminal que quedó eliminado.
          example: pos_q9nP6utIFsVfqndlE25-7_xCV6oiyU0W
          title: Id Pos Terminal
          type: string
      required:
      - id_pos_terminal
      title: DeletedPosTerminalResponse
      type: object
    ApiCards_ErrorDetailResponse:
      description: Cuerpo con que la API responde una petición fallida.
      properties:
        detail:
          description: Descripción legible de por qué falló la petición.
          title: Detail
          type: string
      required:
      - detail
      title: ApiCards_ErrorDetailResponse
      type: object
    ApiCards_PaymentIntentGateway:
      description: 'Integración por la que se cursa un intento de cobro: el adquirente, banco o recaudador concreto que lo ejecuta. La mayoría de los valores corresponde a una institución de un solo país; el resto son mecanismos propios de Toku, como `internal_psp`, `manual_pac` o `external_payment`.


        Es el conjunto más amplio de gateways de Toku y crece cada vez que se habilita una institución nueva, así que conviene leerlo como una lista abierta y no agotar sus valores en el código. Para el gateway con que se inscribió un medio de pago, ver `PaymentMethodGateway`.'
      enum:
      - transbank_oneclick
      - klap_oneclick
      - patpass
      - toku_onetime
      - toku_pac
      - fintoc_pac
      - universo_pac
      - ecert_pac
      - external_pac
      - manual_pac
      - internal_psp
      - domiciliation
      - mx_banco_bbva
      - mx_banco_bancomer
      - payment_orchestration
      - getnet
      - getnet_pos
      - transbank
      - transbank_webpay_plus
      - khipu_transfer
      - fintoc_transfer
      - floid_transfer
      - toku_transfer
      - conciliation
      - pb_transfer_cl_banco_de_chile
      - pb_transfer_cl_banco_de_chile-evertec
      - pb_transfer_cl_banco_santander
      - pb_transfer_cl_banco_santander-evertec
      - pb_transfer_cl_banco_santander_direct
      - pb_transfer_cl_banco_santander-native
      - pb_transfer_cl_banco_scotiabank
      - pb_transfer_cl_banco_scotiabank_direct
      - pb_transfer_cl_banco_scotiabank-native
      - pb_transfer_cl_banco_bci
      - pb_transfer_cl_banco_bci-native
      - pb_transfer_cl_banco_bci_direct
      - pb_transfer_cl_banco_bci-serviex
      - pb_transfer_cl_banco_itau
      - pb_transfer_cl_banco_itau-evertec
      - pb_transfer_cl_banco_estado
      - pb_transfer_cl_banco_bice
      - pb_transfer_cl_banco_falabella
      - arcus_transfer
      - stp_transfer
      - cobre_transfer
      - monex_transfer
      - oxxo
      - paycash
      - dapp
      - tapi
      - puntored
      - cash_pickup
      - multigateway_onetime
      - toku_gateways_conekta
      - toku_gateways_stripe
      - toku_gateways_mercado_pago
      - toku_gateways_open_pay
      - toku_gateways_pay_u
      - toku_gateways_paypal
      - toku_gateways_net_pay
      - po_open_pay
      - po_rapyd
      - po_conekta
      - po_stripe
      - po_kushki
      - po_fiserv
      - po_evo_payments
      - po_paypal
      - po_mit
      - openpay
      - rapyd
      - conekta
      - stripe
      - kushki
      - mit
      - codi_qr
      - codi
      - paypal
      - br_banco_itau
      - br_banco_itau_boleto
      - br_banco_bradesco_boleto
      - br_banco_bradesco_pix
      - br_sicredi_boleto
      - servipag
      - servipag_portal
      - servipag_caja_presencial
      - servipag_caja_express
      - cards_batch_mx_recurring_pst
      - amex_batch_mx_recurring_pst
      - braintree
      - pagarme
      - br_paulista_servicios_automatic_debit
      - mx_banco_santander
      - mx_banco_bbva_bancomer
      - mx_banco_banorte
      - mx_banco_banorte_h2h
      - mx_banco_scotiabank
      - mx_banco_hsbc
      - mx_banco_citibanamex
      - mx_banco_multiva
      - mx_amex
      - mx_banco_banbajio
      - mx_banco_banregio
      - mx_banco_sabadell
      - mx_belvo
      - mx_bbva_cie
      - internal_balance
      - fiserv
      - cielo
      - belvo
      - mx_banco_scotiabank_h2h_external
      - iniciador
      - qi_tech
      - evo_payments
      - cl_banco_de_chile
      - cl_banco_bci
      - cl_banco_santander
      - cl_banco_scotiabank
      - cl_banco_security
      - cl_banco_consorcio_fidi
      - transdata
      - br_banco_do_brasil
      - br_banco_santander
      - br_banco_citibank
      - rede
      - mercadopago
      - br_caixa_via_accesstage
      - br_banco_de_brasilia
      - worldpay
      - br_banco_de_brasilia_via_accesstage
      - br_santander_via_accesstage
      - br_bradesco_via_accesstage
      - br_banco_do_brasil_via_accesstage
      - br_c6_via_accesstage
      - br_sicoob_via_accesstage
      - br_itau_via_accesstage
      - external_payment
      - br_sicoob
      - br_caixa
      - br_btg
      - toku_mx_belvo
      - toku_mx_banco_bbva_bancomer
      - servipag_button
      - servipag_cashier
      - servipag_web
      - servipag_express
      - sencillito_cashier
      - sencillito_web
      - scotiabank_cashier
      - unired
      title: ApiCards_PaymentIntentGateway
      type: string
    UpdatePosTerminalPayload:
      description: 'Datos con que se actualiza un terminal POS: reemplazan por completo a los registrados.'
      properties:
        acquirer_branch_id:
          description: Código de la sucursal del adquirente donde está el terminal.
          example: SUC01
          maxLength: 32
          title: Acquirer Branch Id
          type: string
        acquirer_commerce_code:
          description: Código de comercio del adquirente al que responde el terminal.
          example: '5570001'
          maxLength: 32
          title: Acquirer Commerce Code
          type: string
        device_serial_number:
          description: Número de serie del dispositivo físico.
          example: SN-ABC-001
          maxLength: 32
          title: Device Serial Number
          type: string
        terminal_id:
          description: Identificador del terminal en el adquirente, el mismo que imprime el voucher.
          example: '00000001'
          maxLength: 32
          title: Terminal Id
          type: string
      required:
      - terminal_id
      title: UpdatePosTerminalPayload
      type: object
    CreatePosTerminalPayload:
      description: Datos con que se registra un terminal POS.
      properties:
        acquirer_branch_id:
          description: Código de la sucursal del adquirente donde está el terminal.
          example: SUC01
          maxLength: 32
          title: Acquirer Branch Id
          type: string
        acquirer_commerce_code:
          description: Código de comercio del adquirente al que responde el terminal.
          example: '5570001'
          maxLength: 32
          title: Acquirer Commerce Code
          type: string
        device_serial_number:
          description: Número de serie del dispositivo físico.
          example: SN-ABC-001
          maxLength: 32
          title: Device Serial Number
          type: string
        gateway:
          allOf:
          - $ref: '#/components/schemas/ApiCards_PaymentIntentGateway'
          description: Adquirente del terminal. Queda fijo al registrarlo y es el que cobra en ese dispositivo.
          example: getnet_pos
        terminal_id:
          description: Identificador del terminal en el adquirente, el mismo que imprime el voucher.
          example: '00000001'
          maxLength: 32
          title: Terminal Id
          type: string
        type:
          allOf:
          - $ref: '#/components/schemas/PosTerminalType'
          default: SMART_POS
          description: Tipo de dispositivo. Se declara al registrarlo y después no cambia.
          example: SMART_POS
      required:
      - gateway
      - terminal_id
      title: CreatePosTerminalPayload
      type: object
    PosTerminalListResponse:
      description: Terminales POS que la cuenta tiene registrados.
      properties:
        pos_terminals:
          description: Terminales vigentes de la cuenta, sin los eliminados.
          example:
          - acquirer_branch_id: SUC01
            acquirer_commerce_code: '5570001'
            created_at: '2026-01-15T14:32:07'
            device_serial_number: SN-ABC-001
            gateway: getnet_pos
            id_account: acc_q9nP6utIFsVfqndlE25-7_xCV6oiyU0W
            id_pos_terminal: pos_q9nP6utIFsVfqndlE25-7_xCV6oiyU0W
            terminal_id: '00000001'
            type: SMART_POS
            updated_at: '2026-01-15T14:32:07'
          items:
            $ref: '#/components/schemas/PosTerminalResponse'
          title: Pos Terminals
          type: array
      required:
      - pos_terminals
      title: PosTerminalListResponse
      type: object
    PosTerminalType:
      description: Kind of POS terminal registered for an account.
      enum:
      - SMART_POS
      title: PosTerminalType
      type: string
    PosTerminalResponse:
      description: Terminal POS registrado por una cuenta.
      properties:
        acquirer_branch_id:
          description: Código de la sucursal del adquirente donde está el terminal.
          example: SUC01
          title: Acquirer Branch Id
          type: string
        acquirer_commerce_code:
          description: Código de comercio del adquirente al que responde el terminal.
          example: '5570001'
          title: Acquirer Commerce Code
          type: string
        created_at:
          description: Cuándo se registró el terminal.
          example: '2026-01-15T14:32:07'
          format: date-time
          title: Created At
          type: string
        device_serial_number:
          description: Número de serie del dispositivo físico.
          example: SN-ABC-001
          title: Device Serial Number
          type: string
        gateway:
          allOf:
          - $ref: '#/components/schemas/ApiCards_PaymentIntentGateway'
          description: Adquirente del terminal. Queda fijo al registrarlo y es el que cobra en ese dispositivo.
          example: getnet_pos
        id_account:
          description: Cuenta dueña del terminal, resuelta desde las credenciales de la petición.
          example: acc_q9nP6utIFsVfqndlE25-7_xCV6oiyU0W
          title: Id Account
          type: string
        id_pos_terminal:
          description: Identificador del terminal en Toku.
          example: pos_q9nP6utIFsVfqndlE25-7_xCV6oiyU0W
          title: Id Pos Terminal
          type: string
        terminal_id:
          description: Identificador del terminal en el adquirente, el mismo que imprime el voucher.
          example: '00000001'
          title: Terminal Id
          type: string
        type:
          allOf:
          - $ref: '#/components/schemas/PosTerminalType'
          description: Tipo de dispositivo. Se declara al registrarlo y después no cambia.
          example: SMART_POS
        updated_at:
          description: Última escritura registrada en la fila; hoy no se refresca al actualizar el terminal.
          example: '2026-01-15T14:32:07'
          format: date-time
          title: Updated At
          type: string
      required:
      - id_pos_terminal
      - id_account
      - gateway
      - type
      - terminal_id
      - acquirer_commerce_code
      - acquirer_branch_id
      - device_serial_number
      - created_at
      - updated_at
      title: PosTerminalResponse
      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


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