Skip to main content
POST
Confirmar código de verificação do pedido
Use esta rota quando o pedido vier com next_action.type igual a otp_confirmation. Envie em code o código de verificação que o cliente recebeu. Nenhum pagamento é cobrado antes dessa confirmação.
Com o código correto, o pedido segue para o pagamento e a resposta traz o novo status (processing, requires_capture, requires_action ou paid). Se o pagamento for recusado, a resposta é 402 com failure_reason.
Código inválido ou expirado retorna 422 (confirmation_code_invalid). Sem o campo code, a resposta é 422 (parameter_missing). Um pedido que não aguarda código retorna 422 (order_not_confirmable).
Se o código expirou, gere outro com POST /v2/orders/{id}/confirm/resend. A verificação por código não gera webhook: acompanhe pelo next_action da resposta.

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.

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 do pedido

Pedido. O status é a agregação dos seus pagamentos. processing: em processamento. requires_capture: cartão autorizado, aguardando captura. requires_action: PIX aguardando pagamento ou verificação por código (veja next_action). paid: pago. failed: recusado (veja failure_reason). canceled: cancelado. refunded e partially_refunded: estornado. chargeback: contestado.

id
string

Código do pedido

Example:

"482913"

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

"brl"

amount
integer

Valor total, em centavos

Example:

10000

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.

failure_reason
object

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