---
title: "Criar Cobranças em lote"
method: POST
path: "/collections/batch"
tags: ["Collection"]
---

# Criar Cobranças em lote

`POST /collections/batch`

API responsável por criar cobranças em lote. O contrato da API pode mudar dependendo do tipo da cobrança emitida. Verifique os campos de acordo com o tipo da cobrança

## Request body

- CreateCollectionBatchRequest
  - `batchId` string — Id do lote
  - `number` string, required — Número da conta com dígito
  - `branchCode` string, required — Agência bancária
  - `agreement` string — Número do convênio
  - `collections` union[], required — Objeto de exemplo para criação de todos os tipos de cobranças.
    - union
      - CreateBankslipBatchRequest
        - `amount` number, required — Valor
        - `type` 'BANKSLIP', required — Cobrança do tipo boleto simples
        - `dueDate` string, date, required — Data do vencimento da cobrança
        - `overDueDate` string, date, required — Data de expiração da cobrança
        - `deliveryMediums` string[]
        - `description` string — Descrição do link de pagamento
        - `payer` Payer, required — Pagador
          - `name` string, required
          - `email` string, email
          - `personType` 'F' | 'J', required
          - `phoneNumber` string
          - `taxId` string, required
          - `address` Address
            - `type` 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
            - `zipCode` string
            - `country` string
            - `state` string
            - `city` string
            - `street` string
            - `number` string
            - `complement` string
            - `neighborhood` string
          - `deliveryMediums` string[]
        - `interest` Interest
          - `startDate` string, date
          - `type` 'FIXED_VALUE_PER_DAY' | 'PERCENTAGE_PER_MONTH' | 'NOT_APPLICABLE'
          - `value` number
        - `fine` Fine
          - `startDate` string, date — Data incial
          - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
          - `value` number
        - `discounts` Discount[] — Dados de desconto
          - `limitDate` string, date — Data limite
          - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
          - `value` number
        - `tags` Tag[]
          - `key` string — Chave da tag
          - `value` string — Valor da tag
        - `detail` BankslipDetailBatchRequest, required
          - `documentNumber` string, required — Número de documento da cobrança
          - `correlationId` string — Id de correlação da cobrança
          - `ourNumber` string — Nosso número da cobrança
          - `badCredit` BadCreditIssueDate — Informações de negativação para cobranças com type BANKSLIP ou BANKSLIP_QRCODE
            - `type` 'APPLICABLE' | 'NOT_APPLICABLE', required — Se NOT_APPLICABLE, o campo issueDate não deve ser informado
            - `issueDate` string — Data para negativar a cobrança
          - `installment` number — Número da parcela
        - `invoiceNumber` string — Número da nota fiscal
      - CreateBankslipPixBatchRequest
        - `amount` number, required — Valor
        - `type` 'BANKSLIP_QRCODE', required — Cobrança do tipo bolepix (QrCode de Pix cobrança + Código de barras)
        - `dueDate` string, date, required — Data do vencimento da cobrança
        - `overDueDate` string, date, required — Data de expiração da cobrança
        - `deliveryMediums` string[]
        - `description` string — Descrição do link de pagamento
        - `payer` Payer, required — Pagador
          - `name` string, required
          - `email` string, email
          - `personType` 'F' | 'J', required
          - `phoneNumber` string
          - `taxId` string, required
          - `address` Address
            - `type` 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
            - `zipCode` string
            - `country` string
            - `state` string
            - `city` string
            - `street` string
            - `number` string
            - `complement` string
            - `neighborhood` string
          - `deliveryMediums` string[]
        - `interest` Interest
          - `startDate` string, date
          - `type` 'FIXED_VALUE_PER_DAY' | 'PERCENTAGE_PER_MONTH' | 'NOT_APPLICABLE'
          - `value` number
        - `fine` Fine
          - `startDate` string, date — Data incial
          - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
          - `value` number
        - `discounts` Discount[] — Dados de desconto
          - `limitDate` string, date — Data limite
          - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
          - `value` number
        - `tags` Tag[]
          - `key` string — Chave da tag
          - `value` string — Valor da tag
        - `detail` BankslipPixDetailBatchRequest, required
          - `pixKey` string
          - `txId` string
          - `documentNumber` string, required — Número de documento da cobrança
          - `correlationId` string — Id de correlação da cobrança
          - `ourNumber` string — Nosso número da cobrança
          - `badCredit` BadCreditIssueDate — Informações de negativação para cobranças com type BANKSLIP ou BANKSLIP_QRCODE
            - `type` 'APPLICABLE' | 'NOT_APPLICABLE', required — Se NOT_APPLICABLE, o campo issueDate não deve ser informado
            - `issueDate` string — Data para negativar a cobrança
          - `installment` number — Número da parcela
        - `invoiceNumber` string — Número da nota fiscal
        - `extraInfos` ExtraInfos[]
          - `key` string — Nome da informação extra
          - `value` string — Valor da informação extra
        - `automaticPixDetails` AutomaticPixDetails — Detalhes do Pix Automático (exclusivo para cobranças do tipo BANKSLIP_QRCODE)
          - `contract` string, required — Identificador do contrato (deve ser gerenciado pelo recebedor e não pode ser reutilizado caso esteja associado a uma autorização pendente ou aprovada)
          - `description` string — Descrição do contrato
          - `initialDate` string, required — Data do primeiro pagamento (deve respeitar um intervalo mínimo de 3 dias a partir da data atual)
          - `finalDate` string — Data prevista do último pagamento
          - `totalInstallments` number — Total de pagamentos previstos. Se informado, o campo finalDate deve ser removido
          - `amount` number — Valor fixo que será cobraço em cada ciclo. Importante: para recorrência com valor fixo o agendamento das cobranças será feito automáticamente. Se o valor fixo não for preenchido será considerado como valor variável e o recebedor (beneficiário) deve ser responsável por realizar o agendamento das cobranças
          - `minimumAmountPayee` number — Valor mínimo para pagamento (exclusivo para Pix Automático com valor variável)
          - `period` 'ANNUALLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'WEEKLY', required — Período da autorização
          - `retryPolicy` 'ACCEPT_3R_7D' | 'NOT_APPLICABLE', required — Retentativa de pagamento em caso de saldo insuficiente na conta do pagador. As retentativas são feitas automaticamente, conforme exemplo abaixo: Pagamento foi agendado para o dia 10/12/2025 - 1° tentativa será agendada para o dia 12/12/2015 - 2º tentativa será agendada para o dia 14/12/2015 - 3° tentativa será agendada para o dia 16/12/2015 Conforme regra do Banco Central, podem ser feitas até 3 novas tentativas em dias diferentes dentro do intervalo de 7 dias corridos após a data prevista para liquidação da tentativa original.

## Response `201`

Cobrança criada com sucesso.

- CollectionResponse
  - `collectionId` string, required — Id da cobrança
  - `dueDate` string, date — Data do vencimento da cobrança
  - `overDueDate` string, date — Data de expiração da cobrança
  - `createdAt` string — Data da criação
  - `amount` number — Valor
  - `batchId` string — Id do lote
  - `deliveryMediums` string[]
  - `interest` Interest
    - `startDate` string, date
    - `type` 'FIXED_VALUE_PER_DAY' | 'PERCENTAGE_PER_MONTH' | 'NOT_APPLICABLE'
    - `value` number
  - `fine` Fine
    - `startDate` string, date — Data incial
    - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
    - `value` number
  - `discounts` Discount[]
    - `limitDate` string, date — Data limite
    - `type` 'FIXED_VALUE' | 'NOT_APPLICABLE' | 'PERCENTAGE'
    - `value` number
  - `status` 'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED' — Status da cobrança
  - `type` 'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX' — Boleto de cobrança
  - `payee` Payee — Emissor
    - `document` string
    - `fantasyName` string — Nome
    - `socialName` string — Nome
    - `bankCode` string — Código bancário
    - `bankName` string — Nome
  - `payer` Payer — Pagador
    - `name` string, required
    - `email` string, email
    - `personType` 'F' | 'J', required
    - `phoneNumber` string
    - `taxId` string, required
    - `address` Address
      - `type` 'RESIDENCIAL' | 'COMERCIAL' | 'OUTROS' | 'NATURALIDADE'
      - `zipCode` string
      - `country` string
      - `state` string
      - `city` string
      - `street` string
      - `number` string
      - `complement` string
      - `neighborhood` string
    - `deliveryMediums` string[]
  - `description` string
  - `detail` Detail
    - `barCode` string — Código de barras
    - `digitableLine` string — Linha digitavel
    - `ourNumber` string — Nosso número da cobrança
    - `documentNumber` string — Número de documento da cobrança
    - `emv` string
    - `pixKey` string
    - `txId` string
    - `correlationId` string — Id de correlação da cobrança
    - `badCredit` BadCreditIssueDate — Informações de negativação para cobranças com type BANKSLIP ou BANKSLIP_QRCODE
      - `type` 'APPLICABLE' | 'NOT_APPLICABLE', required — Se NOT_APPLICABLE, o campo issueDate não deve ser informado
      - `issueDate` string — Data para negativar a cobrança
    - `automaticPix` AutomaticPix
      - `authorizationId` string, uuid — Id da autorização do Pix Automático
  - `tags` Tag[]
    - `key` string — Chave da tag
    - `value` string — Valor da tag
  - `updatedAt` string — Data da atualização

## Other responses

- `400` — Bad Request
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/revisions/2a24d3da114c/schema)