---
updatedAt: 2026-06-08T19:56:32.000Z
agentTools:
  projectIndex: https://docs.transfeera.dev/llms.txt
---

# Criar boleto

> 📘
>
> O campo `value` é opcional e é usado apenas se você precisar configurar um valor diferente para o boleto, em casos onde o valor do boleto fica em aberto ou tem juros e multas. Caso contrário não passe esta propriedade.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Pagamentos",
    "contact": {
      "email": "suporte@transfeera.com",
      "name": "Suporte"
    }
  },
  "servers": [
    {
      "url": "https://api.transfeera.com",
      "description": "Produção"
    },
    {
      "url": "https://api-sandbox.transfeera.com",
      "description": "Sandbox"
    }
  ],
  "paths": {
    "/batch/{id}/billet": {
      "post": {
        "tags": [
          "Boletos"
        ],
        "summary": "Criar boleto",
        "parameters": [
          {
            "name": "User-Agent",
            "in": "header",
            "description": "Todas as requests para a API da Transfeera deve conter o Header \"User-Agent\". Use este Header para nos dizer qual o nome da sua empresa e um e-mail para contato",
            "schema": {
              "type": "string",
              "example": "Empresa X (contato@empresax.com)"
            },
            "examples": {
              "default": {
                "value": "Empresa X (contato@empresax.com)"
              }
            }
          },
          {
            "name": "id",
            "in": "path",
            "description": "ID do lote",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/billetReq"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    }
                  },
                  "x-examples": {
                    "Example 1": {
                      "id": "6b871e8d-6f31-436a-a61a-3a6198f76957"
                    }
                  }
                },
                "examples": {
                  "Success": {
                    "value": {
                      "id": "6b871e8d-6f31-436a-a61a-3a6198f76957"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "basic": []
          }
        ],
        "servers": [
          {
            "url": "https://api.transfeera.com",
            "description": "Produção"
          },
          {
            "url": "https://api-sandbox.transfeera.com",
            "description": "Sandbox"
          }
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Boletos"
    }
  ],
  "components": {
    "securitySchemes": {
      "basic": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "billetReq": {
        "type": "object",
        "title": "Boleto",
        "x-examples": {
          "Example 1": {
            "value": 5,
            "payment_date": "2019-02-07",
            "barcode": "23790504004199020709870008109202177960000000600",
            "description": "teste",
            "integration_id": "3"
          }
        },
        "properties": {
          "value": {
            "type": "number",
            "description": "O campo value é opcional e é usado apenas se você precisar configurar um valor diferente para o boleto, em casos onde o valor do boleto fica em aberto ou tem juros e multas. Caso contrário não passe esta propriedade.",
            "format": "float"
          },
          "payment_date": {
            "type": "string"
          },
          "barcode": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "integration_id": {
            "type": "string"
          }
        },
        "required": [
          "payment_date",
          "barcode",
          "description"
        ]
      }
    }
  },
  "security": [
    {
      "basic": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "go",
      "node",
      "javascript",
      "php",
      "python",
      "ruby",
      "kotlin",
      "java"
    ]
  }
}
```