Skip to main content
POST
Capturar pedido
Captura todos os pagamentos com cartão autorizados do pedido. Só é aceita quando o pedido está em requires_capture. Em outro status, a resposta é 422 (order_not_capturable).
Pedidos com cartão + PIX não precisam desta rota: o cartão é capturado automaticamente quando o PIX é pago.
Se a adquirente recusar a captura de algum pagamento, os demais são desfeitos e o pedido falha. A resposta é 402 com status: "failed" e o motivo em failure_reason.
Envie o header Idempotency-Key para reenviar com segurança. Veja Idempotência e limites.

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)

Response

Pedido capturado

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