Toku · Schema

BulkInitializeTransactionResponse

Boletos emitidos na requisição.

FintechPaymentsB2BAutomationChile

Properties

Name Type Description
transactions array Boletos emitidos. Traz um único elemento quando a configuração da Account agrupa as Invoices em um só boleto, e um elemento por Invoice caso contrário.
View JSON Schema on GitHub

JSON Schema

toku-bulk-initialize-transaction-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/toku/json-schema/toku-bulk-initialize-transaction-response-schema.json",
  "title": "BulkInitializeTransactionResponse",
  "description": "Boletos emitidos na requisição.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/toku-boleto-api-openapi.yml#/components/schemas/BulkInitializeTransactionResponse",
  "properties": {
    "transactions": {
      "description": "Boletos emitidos. Traz um único elemento quando a configuração da Account agrupa as Invoices em um só boleto, e um elemento por Invoice caso contrário.",
      "items": {
        "anyOf": [
          {
            "$ref": "#/$defs/InitializeTransactionResponse"
          },
          {
            "$ref": "#/$defs/ExternalBoletoInitializeResponse"
          }
        ]
      },
      "title": "Transactions",
      "type": "array"
    }
  },
  "required": [
    "transactions"
  ],
  "type": "object",
  "$defs": {
    "BoletoAddress-Output": {
      "description": "Endereço impresso no boleto, do beneficiário ou do pagador.",
      "properties": {
        "city": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Cidade.",
          "title": "City"
        },
        "complement": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Complemento do endereço.",
          "title": "Complement"
        },
        "neighborhood": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Bairro.",
          "title": "Neighborhood"
        },
        "number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Número do imóvel.",
          "title": "Number"
        },
        "postal_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "CEP.",
          "title": "Postal Code"
        },
        "state": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Sigla da unidade federativa.",
          "title": "State"
        },
        "street": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Nome da rua ou avenida.",
          "title": "Street"
        }
      },
      "title": "BoletoAddress",
      "type": "object"
    },
    "BoletoBeneficiary-Output": {
      "description": "Beneficiário (cedente) do boleto: quem recebe o pagamento.",
      "properties": {
        "account_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Conta de cobrança.",
          "title": "Account Number"
        },
        "address": {
          "anyOf": [
            {
              "$ref": "#/$defs/BoletoAddress-Output"
            },
            {
              "type": "null"
            }
          ],
          "description": "Endereço do beneficiário."
        },
        "agency": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Agência da conta de cobrança.",
          "title": "Agency"
        },
        "bank_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Código do banco emissor.",
          "title": "Bank Code"
        },
        "code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Código do beneficiário junto ao banco.",
          "title": "Code"
        },
        "government_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "CNPJ do beneficiário.",
          "title": "Government Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Razão social do beneficiário.",
          "title": "Name"
        },
        "wallet": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Carteira de cobrança usada no banco.",
          "title": "Wallet"
        }
      },
      "title": "BoletoBeneficiary",
      "type": "object"
    },
    "BoletoPayer-Output": {
      "description": "Pagador (sacado) do boleto: quem deve pagá-lo.",
      "properties": {
        "address": {
          "anyOf": [
            {
              "$ref": "#/$defs/BoletoAddress-Output"
            },
            {
              "type": "null"
            }
          ],
          "description": "Endereço do pagador."
        },
        "government_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "CPF ou CNPJ do pagador.",
          "title": "Government Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Nome do pagador.",
          "title": "Name"
        }
      },
      "title": "BoletoPayer",
      "type": "object"
    },
    "Boleto_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`.\n\nEs 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": "Boleto_PaymentIntentGateway",
      "type": "string"
    },
    "DiscountResponse": {
      "description": "Desconto por pontualidade registrado no banco.",
      "properties": {
        "amount": {
          "description": "Valor em reais que o banco abate quando o boleto é pago dentro do prazo.",
          "title": "Amount",
          "type": "string"
        },
        "discount_type": {
          "allOf": [
            {
              "$ref": "#/$defs/DiscountType"
            }
          ],
          "description": "Forma de cálculo do desconto configurado: `fee` é um valor fixo em reais e `percentual` é uma porcentagem do valor do boleto."
        },
        "limit_date": {
          "description": "Último dia em que o desconto vale, em dd/mm/aaaa.",
          "title": "Limit Date",
          "type": "string"
        }
      },
      "required": [
        "amount",
        "discount_type",
        "limit_date"
      ],
      "title": "DiscountResponse",
      "type": "object"
    },
    "DiscountType": {
      "description": "How an early-payment discount on a boleto or Pix charge is expressed, mirroring FineType.",
      "enum": [
        "fee",
        "percentual"
      ],
      "title": "DiscountType",
      "type": "string"
    },
    "ExternalBoletoInitializeResponse": {
      "description": "Boleto emitido a partir de Invoices, com os dados necessários para pagá-lo.",
      "properties": {
        "amount": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Valor do boleto, em reais.",
          "title": "Amount"
        },
        "barcode": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Código de barras do boleto.",
          "title": "Barcode"
        },
        "barcode_url": {
          "description": "URL da imagem do código de barras.",
          "title": "Barcode Url",
          "type": "string"
        },
        "beneficiary": {
          "anyOf": [
            {
              "$ref": "#/$defs/BoletoBeneficiary-Output"
            },
            {
              "type": "null"
            }
          ],
          "description": "Dados de quem recebe o pagamento."
        },
        "check_digit": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Dígito verificador do boleto.",
          "title": "Check Digit"
        },
        "currency": {
          "default": "BRL",
          "description": "Moeda do boleto.",
          "title": "Currency",
          "type": "string"
        },
        "document_species": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Espécie do documento.",
          "title": "Document Species"
        },
        "expiration_date": {
          "description": "Data de vencimento, em dd/mm/aaaa.",
          "title": "Expiration Date",
          "type": "string"
        },
        "id_invoices": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "description": "Identificadores das Invoices que o boleto salda.",
          "title": "Id Invoices"
        },
        "id_transaction": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Identificador da Transaction criada para este boleto.",
          "title": "Id Transaction"
        },
        "issue_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Data de emissão, em dd/mm/aaaa.",
          "title": "Issue Date"
        },
        "nosso_numero": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Identificador do boleto junto ao banco emissor.",
          "title": "Nosso Numero"
        },
        "payer": {
          "anyOf": [
            {
              "$ref": "#/$defs/BoletoPayer-Output"
            },
            {
              "type": "null"
            }
          ],
          "description": "Dados de quem deve pagar o boleto."
        },
        "qr": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Conteúdo do QR de pagamento. Presente quando a carteira tem chave Pix.",
          "title": "Qr"
        },
        "qr_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "URL da imagem do QR de pagamento. Presente quando a carteira tem chave Pix.",
          "title": "Qr Url"
        },
        "status": {
          "description": "Resultado da emissão do boleto.",
          "title": "Status",
          "type": "string"
        },
        "typeable_line_number": {
          "description": "Linha digitável do boleto.",
          "title": "Typeable Line Number",
          "type": "string"
        },
        "validity_date": {
          "description": "Data-limite para o banco aceitar o pagamento, em dd/mm/aaaa.",
          "title": "Validity Date",
          "type": "string"
        }
      },
      "required": [
        "status",
        "expiration_date",
        "validity_date",
        "barcode_url",
        "typeable_line_number"
      ],
      "title": "ExternalBoletoInitializeResponse",
      "type": "object"
    },
    "FineType": {
      "enum": [
        "fee",
        "percentual"
      ],
      "title": "FineType",
      "type": "string"
    },
    "InitializeTransactionResponse": {
      "description": "Boleto emitido, com os dados necessários para pagá-lo.",
      "properties": {
        "account_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Nome que aparece no boleto como beneficiário.",
          "title": "Account Name"
        },
        "amount": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Valor do boleto, em reais.",
          "title": "Amount"
        },
        "barcode": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Código de barras do boleto.",
          "title": "Barcode"
        },
        "barcode_url": {
          "description": "URL da imagem do código de barras.",
          "title": "Barcode Url",
          "type": "string"
        },
        "beneficiary": {
          "anyOf": [
            {
              "$ref": "#/$defs/BoletoBeneficiary-Output"
            },
            {
              "type": "null"
            }
          ],
          "description": "Dados de quem recebe o pagamento."
        },
        "check_digit": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Dígito verificador do boleto.",
          "title": "Check Digit"
        },
        "currency": {
          "default": "BRL",
          "description": "Moeda do boleto.",
          "title": "Currency",
          "type": "string"
        },
        "discounts": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/$defs/DiscountResponse"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "description": "Descontos por pontualidade registrados no banco, do prazo mais curto ao mais longo.",
          "title": "Discounts"
        },
        "document_species": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Espécie do documento.",
          "title": "Document Species"
        },
        "expiration_date": {
          "description": "Data de vencimento, em dd/mm/aaaa.",
          "title": "Expiration Date",
          "type": "string"
        },
        "fine": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "description": "Multa aplicada após o vencimento.",
          "title": "Fine"
        },
        "fine_type": {
          "anyOf": [
            {
              "$ref": "#/$defs/FineType"
            },
            {
              "type": "null"
            }
          ],
          "description": "Forma de cálculo da multa cobrada quando o boleto é pago após o vencimento: `fee` é um valor fixo em reais e `percentual` é uma porcentagem do valor do boleto."
        },
        "gateway": {
          "allOf": [
            {
              "$ref": "#/$defs/Boleto_PaymentIntentGateway"
            }
          ],
          "description": "Banco ou provedor que registrou o boleto."
        },
        "id_invoices": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ],
          "description": "Identificadores das Invoices que o boleto salda.",
          "title": "Id Invoices"
        },
        "id_transaction": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Identificador da Transaction criada para este boleto.",
          "title": "Id Transaction"
        },
        "interest": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "description": "Juros ao mês aplicados após o vencimento.",
          "title": "Interest"
        },
        "issue_date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Data de emissão, em dd/mm/aaaa.",
          "title": "Issue Date"
        },
        "nosso_numero": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Identificador do boleto junto ao banco emissor.",
          "title": "Nosso Numero"
        },
        "payer": {
          "anyOf": [
            {
              "$ref": "#/$defs/BoletoPayer-Output"
            },
            {
              "type": "null"
            }
          ],
          "description": "Dados de quem deve pagar o boleto."
        },
        "qr": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Conteúdo do QR de pagamento. Presente quando a carteira tem chave Pix.",
          "title": "Qr"
        },
        "qr_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "URL da imagem do QR de pagamento. Presente quando a carteira tem chave Pix.",
          "title": "Qr Url"
        },
        "typeable_line_number": {
          "description": "Linha digitável do boleto.",
          "title": "Typeable Line Number",
          "type": "string"
        },
        "validity_date": {
          "description": "Data-limite para o banco aceitar o pagamento, em dd/mm/aaaa.",
          "title": "Validity Date",
          "type": "string"
        }
      },
      "required": [
        "expiration_date",
        "validity_date",
        "barcode_url",
        "typeable_line_number",
        "gateway"
      ],
      "title": "InitializeTransactionResponse",
      "type": "object"
    }
  }
}

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for schemas

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

Call it yourself

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

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

Get an API key

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

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