Criar cobrança

Cria uma nova cobrança a ser paga via cartão de crédito, boleto bancário ou Pix. Permite configurar descontos, juros, datas de vencimento, parcelamento e informações do cliente.

Body Params
string
required

ID do cliente associado à cobrança.

string
enum
required

Método de pagamento.

Allowed:
integer
required

Valor total da cobrança, em centavos. Ex: 10000 representa R$ 100,00.

date
required

Data de vencimento no formato Y-m-d (ex: 2025-08-01).

string

Descrição opcional da cobrança.

integer
required

Número de parcelas para pagamento.

boolean

Se true, bloqueia alterações nas parcelas do checkout, impedindo que o usuário modifique valores após a criação. Pode ser true apenas uma vez por cobrança e só é válido para CREDIT_CARD.

integer

Percentual de juros ao mês, em centavos (1 = 0,01%, 250 = 2,5%). Válido apenas para bank_slip e pix.

string
enum

Tipo de multa por atraso. Apenas para BANK_SLIP e PIX.

Allowed:
integer

Valor da multa, em centavos. Apenas para BANK_SLIP e PIX.

string
enum

Tipo de desconto. Apenas para BANK_SLIP e PIX.

Allowed:
integer
enum

Valor do desconto, em centavos. Apenas para BANK_SLIP e PIX.

Allowed:
date

Data limite para aplicar o desconto, no formato Y-m-d. Apenas para BANK_SLIP e PIX.

tags
array of strings

Lista de identificadores ou nomes de tags associadas ao recurso, utilizada para categorizar, filtrar ou agrupar registros de forma personalizada.

tags
boolean
string
string
string
enum
Allowed:
string
enum
Allowed:
string
integer
integer
integer
integer
integer
integer
integer
boolean
boolean
boolean
boolean
boolean
boolean
Response
200
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!