Skip to main content
POST
Reenviar código de verificação da fatura
Reenvia o código de verificação ao comprador de uma fatura em requires_action por verificação. Se a fatura não estiver aguardando código, a resposta é 422 (order_not_confirmable).
Esta rota aceita 5 requisições por minuto por IP de origem. Se a sua plataforma atende várias contas a partir do mesmo servidor, todas dividem esse limite. Ao exceder, a resposta é 429 fora do envelope de erro da v2 ({ "message": "Too Many Attempts." }), com o header Retry-After.
Esta rota não usa Idempotency-Key.

Authorizations

Authorization
string
header
required

Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Ambiente de Sandbox). 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

Código reenviado

Fatura de um ciclo da assinatura. processing: em processamento. requires_action: PIX aguardando pagamento ou verificação por código (veja next_action). paid: paga. failed: recusada (veja failure_reason). canceled: cancelada. refunded e partially_refunded: estornada. chargeback: contestada.

id
string
Example:

"ord_Xc4Vb7Nm2As5Df8G"

object
enum<string>
Available options:
invoice
subscription
string
Example:

"sub_4Hn8Qw2Rt6Yp1Zx3"

number
integer

Número da fatura na assinatura

Example:

1

status
enum<string>
Available options:
processing,
requires_action,
paid,
failed,
canceled,
refunded,
partially_refunded,
chargeback
currency
enum<string>

Sempre brl

Available options:
brl
Example:

"brl"

original_amount
integer

Valor da fatura na moeda da assinatura, em centavos. Igual a amount em BRL

Example:

10000

original_currency
string

Moeda enviada, em minúsculas

Example:

"brl"

exchange_rate
number | null

Cotação usada: 1 unidade da moeda original = exchange_rate reais. null quando a moeda é BRL. Única por fatura: uma nova tentativa reaproveita a cotação da primeira cobrança.

Example:

null

amount
integer

Valor cobrado, em centavos de real, já com descontos e acréscimos. Fecha ao centavo com Σ items[].amount_total − Σ discounts[].amount_applied + Σ increments[].amount_applied. Somar items[].amount × quantity não tem essa garantia.

Example:

9000

attempts
integer

Tentativas de cobrança

items
object[]

Itens da fatura. amount é o valor unitário, em centavos de real, convertido pela exchange_rate. amount_total é o total bruto da linha, em centavos de real, conciliado com o amount da fatura.

discounts
object[]

Descontos da fatura. value é o valor declarado: em fixed, centavos de real convertidos pela exchange_rate; em percentage, o percentual, sem conversão. amount_applied é o valor efetivamente descontado, em centavos de real.

increments
object[]

Acréscimos da fatura, com os mesmos campos de discounts. amount_applied é o valor efetivamente acrescido, em centavos de real. Acréscimos não têm limite.

payments
object[]
next_action
object | null

O que precisa acontecer para o pagamento seguir. pix_display_qr_code: exiba o QR Code para o pagador. otp_confirmation: a análise de fraude pediu verificação — nada é cobrado até o código ser confirmado na rota /confirm.

created_at
string
failure_reason
object

Motivo da recusa. Presente só quando o status é failed