{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/toku/json-schema/toku-create-bulk-automatic-debit-payment-method-payload-schema.json",
  "title": "CreateBulkAutomaticDebitPaymentMethodPayload",
  "description": "Lote de contas bancárias a cadastrar para Débito Automático em uma Account.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/toku-d-bito-autom-tico-api-openapi.yml#/components/schemas/CreateBulkAutomaticDebitPaymentMethodPayload",
  "properties": {
    "bank": {
      "allOf": [
        {
          "$ref": "#/$defs/AutomaticDebitBank"
        }
      ],
      "default": "Banco de Brasilia",
      "description": "Banco que processará os débitos de todas as contas do lote."
    },
    "id_account": {
      "description": "Identificador da Account dona das Subscriptions.",
      "title": "Id Account",
      "type": "string"
    },
    "payment_method_data": {
      "description": "Contas a cadastrar. Cada item gera um Payment Method próprio.",
      "items": {
        "$ref": "#/$defs/PaymentMethodData"
      },
      "title": "Payment Method Data",
      "type": "array"
    }
  },
  "required": [
    "id_account",
    "payment_method_data"
  ],
  "type": "object",
  "$defs": {
    "AddressData": {
      "description": "Endereço de cobrança do pagador, guardado junto à conta cadastrada.",
      "properties": {
        "admin_area": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Unidade federativa ou região administrativa do endereço.",
          "title": "Admin Area"
        },
        "admin_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Admin Code"
        },
        "city": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Cidade do endereço.",
          "title": "City"
        },
        "detail": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Complemento do endereço, como bloco, andar ou apartamento.",
          "title": "Detail"
        },
        "neighborhood": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Bairro do endereço.",
          "title": "Neighborhood"
        },
        "postal_code": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "CEP do endereço.",
          "title": "Postal Code"
        },
        "street_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Nome da rua ou avenida.",
          "title": "Street Name"
        },
        "street_number": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Número do imóvel.",
          "title": "Street Number"
        }
      },
      "title": "AddressData",
      "type": "object"
    },
    "AutomaticDebitBank": {
      "description": "Banco em que o pagador autorizou o débito na sua conta.",
      "enum": [
        "Banco de Brasilia",
        "Banco Santander",
        "Banco Bradesco",
        "Banco do Brasil",
        "C6 Bank",
        "Sicoob",
        "Caixa Economica Federal",
        "Banco Itau",
        "BTG Pactual"
      ],
      "title": "AutomaticDebitBank",
      "type": "string"
    },
    "BtgMandateData": {
      "description": "Mandato que o pagador já tem na BTG, usado para montar cada cobrança.",
      "properties": {
        "contract_identification": {
          "description": "Número da apólice coberta pelo mandato.",
          "minLength": 1,
          "title": "Contract Identification",
          "type": "string"
        },
        "product_code": {
          "description": "Código do produto do mandato na BTG, por exemplo LIFE_10.",
          "minLength": 1,
          "title": "Product Code",
          "type": "string"
        },
        "signature_date": {
          "description": "Data de assinatura do mandato, no formato YYYY-MM-DD.",
          "format": "date",
          "title": "Signature Date",
          "type": "string"
        }
      },
      "required": [
        "contract_identification",
        "signature_date",
        "product_code"
      ],
      "title": "BtgMandateData",
      "type": "object"
    },
    "PaymentMethodAdditionalData": {
      "description": "Dados próprios do banco que processa os débitos.",
      "properties": {
        "btg": {
          "anyOf": [
            {
              "$ref": "#/$defs/BtgMandateData"
            },
            {
              "type": "null"
            }
          ],
          "description": "Mandato BTG do pagador. Obrigatório quando o banco é BTG Pactual e ignorado nos demais."
        }
      },
      "title": "PaymentMethodAdditionalData",
      "type": "object"
    },
    "PaymentMethodData": {
      "description": "Conta bancária a cadastrar e as Subscriptions que ela passa a debitar.",
      "properties": {
        "account_number": {
          "description": "Número da conta do pagador, incluindo o dígito verificador.",
          "maxLength": 14,
          "title": "Account Number",
          "type": "string"
        },
        "account_type": {
          "default": "CORRENTE",
          "description": "Tipo da conta do pagador, tal como o banco a identifica.",
          "title": "Account Type",
          "type": "string"
        },
        "additional_data": {
          "anyOf": [
            {
              "$ref": "#/$defs/PaymentMethodAdditionalData"
            },
            {
              "type": "null"
            }
          ],
          "description": "Dados próprios do banco que processa os débitos."
        },
        "address": {
          "anyOf": [
            {
              "$ref": "#/$defs/AddressData"
            },
            {
              "type": "null"
            }
          ],
          "description": "Endereço de cobrança a guardar junto com a conta."
        },
        "agency": {
          "description": "Agência em que a conta do pagador está aberta.",
          "title": "Agency",
          "type": "string"
        },
        "government_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "CPF ou CNPJ do titular da conta. Quando não é enviado, usa-se o documento já registrado no Customer da Subscription.",
          "title": "Government Id"
        },
        "id_subscriptions": {
          "description": "Identificadores das Subscriptions que serão debitadas nesta conta.",
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "title": "Id Subscriptions",
          "type": "array"
        },
        "requires_opt_in": {
          "default": false,
          "description": "Indica que este pagador ainda não autorizou o débito automático. Em true a conta é cadastrada sem adesão e fica aguardando a solicitação de opt-in; em false é cadastrada pronta para ser debitada.",
          "title": "Requires Opt In",
          "type": "boolean"
        },
        "sender_bank_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Identificador único do pagador. Obrigatório para os bancos que operam em CNAB 150. Para BTG Pactual é o pactualId do mandato.",
          "title": "Sender Bank Id"
        }
      },
      "required": [
        "id_subscriptions",
        "account_number",
        "agency"
      ],
      "title": "PaymentMethodData",
      "type": "object"
    }
  }
}