Toku Pix Automático API

openapi: 3.2.0
info:
  title: Recursos secundarios Pix Automático API
  version: 1.0.0
  description: 'Cobrança recorrente por Pix Automático no Brasil: cadastro da recorrência no banco do pagador, cobrança das Invoices de cada ciclo, retentativas e cancelamento.


    Nesta seção, as operações disponíveis para integradores são o cadastro do Payment Method via notificação push e a configuração de cobrança de uma Subscription. As demais são operações internas, chamadas pelos próprios processos da Toku e pelas notificações dos bancos.'
servers:
- description: Production
  url: https://api.trytoku.com
security:
- ApiKeyAuth: []
tags:
- description: 'Cobrança recorrente por Pix Automático no Brasil: cadastro da recorrência no banco do pagador, cobrança das Invoices de cada ciclo, retentativas e cancelamento.


    Nesta seção, as operações disponíveis para integradores são o cadastro do Payment Method via notificação push e a configuração de cobrança de uma Subscription. As demais são operações internas, chamadas pelos próprios processos da Toku e pelas notificações dos bancos.'
  name: Pix Automático
  x-toku-docs:
    category: brazil
paths:
  /brazil/pix_automatic/initialize-enrollment/push-notification:
    post:
      description: Cadastra o Payment Method de Pix Automático e cria a recorrência no banco do pagador.
      operationId: initialize_push_notification_enrollment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeInscriptionPayload'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitializePushNotificationEnrollmentResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais estão ausentes ou são inválidas.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais não dão acesso a este recurso.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorDetailResponse'
          description: O recurso solicitado não existe.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ValidationErrorResponse'
          description: O corpo da requisição não passou na validação.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: O limite de requisições permitidas foi excedido.
      summary: Cadastrar Payment Method via notificação push
      tags:
      - Pix Automático
      x-toku-docs:
        group: Cadastro
  /brazil/pix_automatic_configuration:
    post:
      description: Registra a configuração de cobrança do Pix Automático de uma Subscription.
      operationId: create_pix_automatic_configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdatePixAutomaticConfigurationPayload'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
          description: Configuração de cobrança registrada.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais estão ausentes ou são inválidas.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais não dão acesso a este recurso.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorDetailResponse'
          description: O recurso solicitado não existe.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ValidationErrorResponse'
          description: O corpo da requisição não passou na validação.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: O limite de requisições permitidas foi excedido.
      summary: Criar Pix Automatic Configuration
      tags:
      - Pix Automático
      x-toku-docs:
        group: Configuração de cobrança
    patch:
      description: Atualiza a configuração de cobrança do Pix Automático de uma Subscription.
      operationId: update_pix_automatic_configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdatePixAutomaticConfigurationPayload'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
          description: Configuração de cobrança atualizada.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais estão ausentes ou são inválidas.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais não dão acesso a este recurso.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorDetailResponse'
          description: A Subscription não tem configuração de cobrança registrada.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ValidationErrorResponse'
          description: O corpo da requisição não passou na validação.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: O limite de requisições permitidas foi excedido.
      summary: Atualizar Pix Automatic Configuration
      tags:
      - Pix Automático
      x-toku-docs:
        group: Configuração de cobrança
  /brazil/pix_automatic_configuration/{id_subscription}:
    get:
      description: Devolve a configuração de cobrança do Pix Automático de uma Subscription.
      operationId: get_pix_automatic_configuration
      parameters:
      - description: Identificador da Subscription configurada.
        example: sub_uSikDF1U0fD6SKR46_gTUU7Pbm4Odl22
        in: path
        name: id_subscription
        required: true
        schema:
          description: Identificador da Subscription configurada.
          title: Id Subscription
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomaticConfigurationResponse'
          description: Configuração de cobrança registrada para a Subscription. Os campos sem valor são omitidos.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais estão ausentes ou são inválidas.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais não dão acesso a este recurso.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorDetailResponse'
          description: A Subscription não tem configuração de cobrança registrada.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ValidationErrorResponse'
          description: O corpo da requisição não passou na validação.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: O limite de requisições permitidas foi excedido.
      summary: Obter Pix Automatic Configuration
      tags:
      - Pix Automático
      x-toku-docs:
        group: Configuração de cobrança
    delete:
      description: Marca como excluída a configuração de cobrança do Pix Automático de uma Subscription.
      operationId: soft_delete_pix_automatic_configuration
      parameters:
      - description: Identificador da Subscription configurada.
        example: sub_uSikDF1U0fD6SKR46_gTUU7Pbm4Odl22
        in: path
        name: id_subscription
        required: true
        schema:
          description: Identificador da Subscription configurada.
          title: Id Subscription
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                status: deleted
              schema:
                $ref: '#/components/schemas/StatusResponse'
          description: Configuração de cobrança marcada como excluída.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais estão ausentes ou são inválidas.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: As credenciais não dão acesso a este recurso.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorDetailResponse'
          description: A Subscription não tem configuração de cobrança registrada.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ValidationErrorResponse'
          description: O corpo da requisição não passou na validação.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomatic_ErrorResponse'
          description: O limite de requisições permitidas foi excedido.
      summary: Excluir Pix Automatic Configuration
      tags:
      - Pix Automático
      x-toku-docs:
        group: Configuração de cobrança
components:
  schemas:
    CollectionFrequency:
      description: 'Periodicidade da recorrência de uma cobrança do Pix Automático: de quanto em quanto tempo o banco do pagador autoriza o próximo débito. Os valores são os que o banco espera, por isso mantêm a nomenclatura em português.'
      enum:
      - SEMANAL
      - MENSAL
      - TRIMESTRAL
      - SEMESTRAL
      - ANUAL
      title: CollectionFrequency
      type: string
    CreateOrUpdatePixAutomaticConfigurationPayload:
      description: 'Configuração de cobrança do Pix Automático de uma Subscription.


        O que for informado aqui tem prioridade sobre a configuração da Account e sobre os padrões do serviço, sempre que a configuração é aplicada.'
      properties:
        allow_retries:
          anyOf:
          - type: boolean
          - type: 'null'
          description: 'Política de retentativas com que a recorrência é cadastrada: com `true`, até 3 retentativas em 7 dias. Alguns provedores cadastram sempre com retentativas, independentemente deste campo.'
          examples:
          - true
          title: Allow Retries
        business_day_only_collection:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Quando `true`, a cobrança é enviada com o ajuste para dia útil, nos provedores que aceitam esse ajuste.
          examples:
          - false
          title: Business Day Only Collection
        collection_day:
          anyOf:
          - type: integer
          - type: 'null'
          description: Dia do mês registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.
          title: Collection Day
        collection_frequency:
          anyOf:
          - $ref: '#/components/schemas/CollectionFrequency'
          - type: 'null'
          description: Periodicidade da recorrência enviada ao banco.
        days_between_retries:
          anyOf:
          - type: integer
          - type: 'null'
          description: Dias entre retentativas registrados na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.
          title: Days Between Retries
        final_date:
          anyOf:
          - type: string
          - type: 'null'
          description: Data a partir da qual a recorrência deixa de valer, no formato `YYYY-MM-DD`. Quando ausente, a recorrência é cadastrada sem data de término.
          title: Final Date
        first_payment_date:
          anyOf:
          - type: string
          - type: 'null'
          description: Data da primeira cobrança, no formato `YYYY-MM-DD`. Quando ausente, o cadastro da recorrência usa a data do dia.
          examples:
          - '2028-07-01'
          title: First Payment Date
        fixed_value:
          anyOf:
          - type: number
          - type: 'null'
          description: Valor fixo de cada cobrança, em reais, enviado ao banco como valor da recorrência.
          title: Fixed Value
        id_subscription:
          description: Identificador da Subscription cuja cobrança está sendo configurada.
          examples:
          - sub_uSikDF1U0fD6SKR46_gTUU7Pbm4Odl22
          title: Id Subscription
          type: string
        maximum_value:
          anyOf:
          - type: number
          - type: 'null'
          description: Valor máximo registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.
          title: Maximum Value
        minimum_value:
          anyOf:
          - type: number
          - type: 'null'
          description: Valor mínimo autorizado para cada cobrança, em reais.
          examples:
          - 10
          title: Minimum Value
      required:
      - id_subscription
      title: CreateOrUpdatePixAutomaticConfigurationPayload
      type: object
    PixAutomatic_AccountType:
      description: 'Tipo de conta bancária brasileira do pagador: `CORRENTE` (conta corrente), `POUPANCA` (conta poupança) e `PAGAMENTO` (conta de pagamento).'
      enum:
      - CORRENTE
      - POUPANCA
      - PAGAMENTO
      title: PixAutomatic_AccountType
      type: string
    PixAutomatic_ErrorResponse:
      description: Cuerpo de error canónico de la API, con el detalle anidado bajo `error`.
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      required:
      - error
      title: PixAutomatic_ErrorResponse
      type: object
    InitializeInscriptionPayload:
      description: Dados da conta do pagador para cadastrar a recorrência do Pix Automático.
      properties:
        agencia:
          description: Agência da conta do pagador, com 4 caracteres.
          examples:
          - '0000'
          title: Agencia
          type: string
        bank_name:
          anyOf:
          - type: string
          - type: 'null'
          description: Nome do banco do pagador, usado para resolver o ISPB quando `ispb` não é enviado. Precisa corresponder exatamente a um dos nomes de banco aceitos.
          examples:
          - Itaú
          title: Bank Name
        conta:
          description: Número da conta do pagador, sem pontos nem símbolos e incluindo o dígito verificador. Se o dígito verificador for `X`, envie `0` no lugar.
          examples:
          - '123213'
          title: Conta
          type: string
        id_customer:
          description: Identificador do Customer dono da conta que pagará a recorrência.
          examples:
          - cus_vxLdK-Grvor8vRLiZ_9LlYesHzkb6sb0
          title: Id Customer
          type: string
        id_subscription:
          description: Identificador da Subscription que passará a ser cobrada por Pix Automático.
          examples:
          - sub_uSikDF1U0fD6SKR46_gTUU7Pbm4Odl22
          title: Id Subscription
          type: string
        ispb:
          anyOf:
          - type: string
          - type: 'null'
          description: ISPB do banco do pagador, com 8 caracteres. Quando vem preenchido, tem prioridade sobre `bank_name`.
          examples:
          - '60701190'
          title: Ispb
        tipo_conta:
          allOf:
          - $ref: '#/components/schemas/PixAutomatic_AccountType'
          description: Tipo da conta do pagador.
      required:
      - id_subscription
      - id_customer
      - agencia
      - conta
      - tipo_conta
      title: InitializeInscriptionPayload
      type: object
    ErrorDetail:
      description: 'Detalle de un error de la API: mensaje legible y código interno estable.'
      properties:
        code:
          description: Código de error interno de Toku (formato `TKxxxxx`), estable. El listado completo está en [Códigos de API](/reference/codigos-de-api).
          title: Code
          type: string
        message:
          description: Descripción legible de qué salió mal.
          title: Message
          type: string
      required:
      - message
      - code
      title: ErrorDetail
      type: object
    StatusResponse:
      description: Resultado do processamento da requisição, em um único campo.
      properties:
        status:
          description: Resultado do processamento.
          examples:
          - success
          title: Status
          type: string
      required:
      - status
      title: StatusResponse
      type: object
    PixAutomatic_ValidationErrorResponse:
      description: Corpo devolvido quando o corpo da requisição não passa na validação.
      properties:
        detail:
          description: Campos que não passaram na validação.
          items:
            $ref: '#/components/schemas/PixAutomatic_ValidationErrorItem'
          title: Detail
          type: array
      required:
      - detail
      title: PixAutomatic_ValidationErrorResponse
      type: object
    PixAutomatic_ValidationErrorItem:
      description: Campo do corpo da requisição que não passou na validação.
      properties:
        loc:
          description: Caminho do campo que falhou.
          examples:
          - - body
            - agencia
          items:
            anyOf:
            - type: string
            - type: integer
          title: Loc
          type: array
        msg:
          description: Motivo da falha de validação.
          examples:
          - field required
          title: Msg
          type: string
        type:
          description: Tipo do erro de validação.
          examples:
          - value_error.missing
          title: Type
          type: string
      required:
      - loc
      - msg
      - type
      title: PixAutomatic_ValidationErrorItem
      type: object
    InitializePushNotificationEnrollmentResponse:
      description: Recorrência criada no banco do pagador a partir de uma notificação push.
      properties:
        copy_paste_code:
          anyOf:
          - type: string
          - type: 'null'
          description: Não é preenchido no cadastro via notificação push.
          title: Copy Paste Code
        id_payment_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Identificador do Payment Method criado para a Subscription.
          examples:
          - pm_ZOd2Ii7ROl8NmytGBhj5ob4cMcNv6bWG
          title: Id Payment Method
        id_transaction:
          anyOf:
          - type: string
          - type: 'null'
          description: Não é preenchido no cadastro via notificação push.
          title: Id Transaction
        metadata:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          description: Dados adicionais devolvidos pelo banco. Com a QI Tech, traz `recurrence_spi_id`.
          title: Metadata
        recurrence_id:
          description: Identificador da recorrência criada no banco do pagador.
          examples:
          - RR904008882025071400000000022
          title: Recurrence Id
          type: string
        status:
          description: Resultado do cadastro da recorrência no banco.
          examples:
          - success
          title: Status
          type: string
        transaction_amount:
          anyOf:
          - type: integer
          - type: number
          - type: 'null'
          description: Não é preenchido no cadastro via notificação push.
          title: Transaction Amount
        txid:
          anyOf:
          - type: string
          - type: 'null'
          description: Não é preenchido no cadastro via notificação push.
          title: Txid
      required:
      - status
      - recurrence_id
      title: InitializePushNotificationEnrollmentResponse
      type: object
    PixAutomatic_ErrorDetailResponse:
      description: Corpo devolvido quando a requisição é rejeitada.
      properties:
        detail:
          description: Mensagem que descreve o motivo da rejeição.
          examples:
          - Pix Automatic Configuration not found
          title: Detail
          type: string
      required:
      - detail
      title: PixAutomatic_ErrorDetailResponse
      type: object
    PixAutomaticConfigurationResponse:
      description: Configuração de cobrança do Pix Automático registrada para uma Subscription.
      properties:
        allow_retries:
          anyOf:
          - type: boolean
          - type: 'null'
          description: 'Política de retentativas com que a recorrência foi cadastrada: com `true`, até 3 retentativas em 7 dias.'
          examples:
          - true
          title: Allow Retries
        business_day_only_collection:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Quando `true`, a cobrança é enviada com o ajuste para dia útil, nos provedores que aceitam esse ajuste.
          examples:
          - false
          title: Business Day Only Collection
        collection_day:
          anyOf:
          - type: integer
          - type: 'null'
          description: Dia do mês registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.
          title: Collection Day
        collection_frequency:
          anyOf:
          - $ref: '#/components/schemas/CollectionFrequency'
          - type: 'null'
          description: Periodicidade da recorrência enviada ao banco.
          examples:
          - MENSAL
        created_at:
          description: Data em que a configuração foi criada.
          examples:
          - '2025-10-29T20:38:19.984485'
          format: date-time
          title: Created At
          type: string
        days_between_retries:
          anyOf:
          - type: integer
          - type: 'null'
          description: Dias entre retentativas registrados na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.
          title: Days Between Retries
        deleted_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Data em que a configuração foi excluída.
          title: Deleted At
        final_date:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Data a partir da qual a recorrência deixa de valer.
          title: Final Date
        first_payment_date:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: Data da primeira cobrança.
          examples:
          - '2028-07-01T00:00:00'
          title: First Payment Date
        fixed_value:
          anyOf:
          - type: number
          - type: 'null'
          description: Valor fixo de cada cobrança, em reais.
          title: Fixed Value
        id_subscription:
          description: Identificador da Subscription configurada.
          examples:
          - sub_uSikDF1U0fD6SKR46_gTUU7Pbm4Odl22
          title: Id Subscription
          type: string
        maximum_value:
          anyOf:
          - type: number
          - type: 'null'
          description: Valor máximo registrado na configuração. Hoje não é enviado ao banco nem usado no cálculo das cobranças.
          title: Maximum Value
        minimum_value:
          anyOf:
          - type: number
          - type: 'null'
          description: Valor mínimo autorizado para cada cobrança, em reais.
          examples:
          - 10
          title: Minimum Value
        updated_at:
          description: Data da última alteração da configuração.
          examples:
          - '2025-10-29T20:38:19.984485'
          format: date-time
          title: Updated At
          type: string
      required:
      - created_at
      - updated_at
      - id_subscription
      title: PixAutomaticConfigurationResponse
      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


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/toku/openapi/toku-pix-autom-tico-api-openapi.yml