Skip to main content
POST
Requer o header account. A fatura deve estar em status Pending ou Fail, e a assinatura precisa estar ativa. Ao usar CreditCard, o objeto card com os dados do cartão é obrigatório. Métodos aceitos: CreditCard, PIX.
A resposta de sucesso retorna diretamente os dados da cobrança (sem envelope APIReturnUtil), incluindo dados de pagamento (PIX com QR code, cartão com ID, etc.). Cobranças pendentes anteriores da fatura são canceladas automaticamente antes de criar a nova.

Authorizations

​
Authorization
string
header
required

Token JWT obtido via POST /v1/login. Envie no header Authorization: Bearer <token>.

Headers

​
account
string
required

Código da conta à qual a operação se aplica

Example:

"acc_abc123xyz"

Path Parameters

​
invoice_code
string
required

Código único da fatura (pedido)

Example:

"ord_xyz456"

Body

application/json
​
method
enum<string>
required

Método de pagamento para quitação (obrigatório)

Available options:
CreditCard,
PIX
Example:

"CreditCard"

​
card
object | null

Dados do cartão (obrigatório se method=CreditCard)

Response

Cobrança criada e processada com sucesso

Resposta do pagamento de fatura em atraso. Esta rota NÃO usa o envelope APIReturnUtil; retorna diretamente os dados da cobrança criada.

​
invoice_code
string

Código da fatura (pedido)

Example:

"ord_xyz456"

​
code
string

Código da cobrança criada

Example:

"chg_abc123"

​
status
string

Status da cobrança

Example:

"Pending"

​
amount
integer

Valor da cobrança em centavos

Example:

9990

​
canceled_amount
number

Valor cancelado

Example:

0

​
installments
integer

Número de parcelas

Example:

1

​
payment
object