Skip to main content
POST
Confirmar código de verificação da fatura
Quando a análise de fraude pede verificação, a fatura fica em requires_action com next_action.type = "otp_confirmation" e nada é cobrado até a confirmação. Envie em code o código que o comprador recebeu.
Com o código válido, a cobrança da fatura é retomada. A resposta é 200 com a fatura atualizada (em geral processing), ou 402 se a cobrança for recusada.
Erros possíveis: 422 parameter_missing (sem code), 422 confirmation_code_invalid (código inválido ou expirado) e 422 order_not_confirmable (a fatura não está aguardando código).

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.

Headers

Idempotency-Key
string

Chave de idempotência opcional e recomendada. Tem até 128 caracteres e vale por 24 horas, por conta. A mesma chave com o mesmo corpo devolve a resposta original (mesmo status e mesmo corpo), sem processar de novo. Só respostas 2xx ficam guardadas: depois de um erro, a mesma chave pode ser reutilizada. A mesma chave com um corpo diferente retorna 422 (idempotency_key_conflict), uma requisição original ainda em andamento retorna 409 (idempotency_key_in_use) e uma chave com mais de 128 caracteres retorna 400 (idempotency_key_invalid).

Maximum string length: 128
Example:

"pedido-1024-tentativa-1"

Path Parameters

id
string
required

Identificador do recurso (o campo id devolvido pela API)

Body

application/json
code
string
required

Código de verificação recebido pelo pagador

Example:

"482019"

Response

Código confirmado. Confira o status da fatura

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