Skip to main content
GET
Consultar cobrança
O id da cobrança é o mesmo id do pagamento (payment_intent) dentro do pedido ou da fatura.
Uma cobrança de outra conta retorna 404 (resource_missing).
Use amount_refundable para saber quanto ainda pode ser estornado antes de chamar o estorno.

Authorizations

Authorization
string
header
required

Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Dev mode). Envie no header Authorization: Bearer <chave>. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header account. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.

Path Parameters

id
string
required

Identificador do recurso (o campo id devolvido pela API)

Response

Cobrança encontrada

Visão financeira de um pagamento

id
string
Example:

"cha_8Kq2Lm9XvB3nT7pZ"

object
enum<string>
Available options:
charge
amount
integer

Valor em centavos

Example:

10000

currency
string
Example:

"brl"

status
enum<string>

failed também cobre cobranças canceladas e expiradas. refund_processing: um estorno foi pedido e aguarda confirmação.

Available options:
pending,
paid,
refund_processing,
partially_refunded,
refunded,
chargeback,
failed
paid
boolean

A cobrança foi paga (inclusive se depois foi estornada)

captured
boolean

A cobrança foi capturada (mesmo valor de paid)

amount_refunded
integer

Valor já estornado, em centavos

Example:

0

amount_refundable
integer

Valor que ainda pode ser estornado, em centavos

Example:

10000

payment_method_details
object
payment_intent
string

O id do pagamento correspondente no pedido ou na fatura

Example:

"cha_8Kq2Lm9XvB3nT7pZ"