Skip to main content
GET
Consultar cobrança
O 404 não distingue “não existe” de “existe, mas é de outra conta”. Responder a diferença confirmaria a existência de cobranças alheias a quem tentasse adivinhar códigos.

Authorizations

Authorization
string
header
required

Chave secreta do vendedor, criada no painel em Desenvolvedores.

O valor em claro existe uma única vez, na criação. Guardamos só o hash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto: um dump do nosso banco não permite cobrar em nome de ninguém.

A chave vai no servidor. Colocá-la no navegador do comprador a entrega a qualquer pessoa que abra a página.

Path Parameters

code
string
required

Código público da cobrança, no formato ch_….

Pattern: ^ch_[0-9a-z]{26}$

Response

A cobrança.

object
string
required
Allowed value: "charge"
id
string
required

Código público da cobrança. Nunca é a chave primária: expor o autoincremento diria a qualquer cliente quantas vendas a plataforma inteira processou.

Example:

"ch_01k1y6r6m6q2x0p3d9v4t7c8n2"

status
enum<string>
required

Situação da cobrança. Todos os estados exceto pending são terminais - exceto os que ainda admitem estorno.

partially_refunded é estado próprio, e não um refunded com asterisco: tratar uma venda devolvida pela metade como estornada faria seu relatório descontar o valor inteiro.

Available options:
pending,
paid,
expired,
canceled,
partially_refunded,
refunded,
failed
payment_method
enum<string>
required
Available options:
pix
amount
integer<int64>
required

Valor cobrado, em centavos inteiros.

currency
string
required
Allowed value: "BRL"
platform_fee
integer<int64>

Nossa taxa, em centavos inteiros. Congelada na criação: reflete o contrato que valia quando a venda aconteceu, não o de hoje.

net_amount
integer<int64>

O que fica com o vendedor, em centavos inteiros (amount - platform_fee).

refunded_amount
integer<int64>

Total já devolvido ao comprador, em centavos inteiros. Acumulado entre estornos parciais.

description
string | null
reference
string | null
customer
object

O comprador, como devolvemos.

pix
object
created_at
string<date-time> | null
paid_at
string<date-time> | null
expired_at
string<date-time> | null
refunded_at
string<date-time> | null