---
title: "Exportar Lote no Formato .zip"
method: POST
path: "/v1/bank_billet_batches/{id}/zip"
tags: ["Lotes"]
---

# Exportar Lote no Formato .zip

`POST /v1/bank_billet_batches/{id}/zip`

## Request

- Base URL: `https://api-sandbox.kobana.com.br`
- URL: `https://api-sandbox.kobana.com.br/v1/bank_billet_batches/{id}/zip`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kobana/apis/cobran-as/docs/v1/bank_billet_batches/:id/zip/post.ts> (a function with typed inputs; its response is checked against the schema)

Exportar lote no formato .zip.

Após a requisição a exportação entra numa fila para gerar o arquivo do lote. A URL do arquivo do lote será retornada pelo endpoint de [Exportação do Lote](/reference/get_v1-bank-billet-batch-exports-id).

## Path parameters

- `id` string, required

## Headers

- `User-Agent` string
- `X-Idempotency-Key` string

## Response `201`

Solicitação de exportação do lote criada com sucesso

- BankBilletBatchExportObject
  - `id` integer: ID arquivo de exportação do lote
  - `account_id` integer: ID da conta
  - `bank_billet_batch_id` integer: ID do lote
  - `status` 'pending' | 'enqueued' | 'processed' | 'failed': Situação da exportação do lote: * `pending` Pendente * `enqueued` Na Fila * `processed` Processado * `failed` Falhou
  - `file_format` 'zip' | 'pdf': Formato do Arquivo: * `zip` Pendente * `pdf` Na Fila
  - `output_url` string, nullable: Url do arquivo.
  - `processed_at` string, date-time, nullable: Data e hora do processamento.
  - `created_at` string, date-time, nullable: Data e hora de criação.
  - `updated_at` string, date-time, nullable: Data e hora da última atualização.

## Other responses

- `401`: Falha de autenticação. Token inválido
- `403`: Falha de permissão. Você não tem o Scope obrigatório para essa chamada.
- `404`: Lote não encontrado

---

[API](https://skmtc.dev/kobana/apis/cobran-as.md) - [All operations](https://skmtc.dev/kobana/apis/cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/kobana/apis/cobran-as/revisions/728c362ec4d7?raw)