Skip to main content
POST
Criar uma nova cobrança

Authorizations

Authorization
string
header
required

Token JWT obtido em /auth/login, enviado no cabeçalho Authorization no formato Bearer <token>.

Body

application/json

Dados para a criação de uma cobrança.

amount
number<double>
required

Valor da cobrança em reais.

Example:

150.75

description
string
required
Example:

"Assinatura Mensal"

customer_name
string
required
Example:

"Maria da Silva"

customer_email
string<email>
required
Example:

"maria@cliente.com"

expires_at
string<date-time>
required
Example:

"2026-09-30T23:59:59Z"

customer_id
string<uuid>

ID de um cliente já cadastrado (opcional).

customer_cpf
string
Example:

"12345678901"

customer_phone
string
Example:

"(11) 91234-5678"

due_date
string<date-time>
txid
string

Identificador da transação (gerado automaticamente se omitido).

Response

Cobrança criada com sucesso.

data
object

Objeto representando uma cobrança (com ou sem Pix emitido).