Captura

Capturar um pagamento confirma que ele está pronto para a liquidação financeira. Isso transfere os fundos autorizados da conta do portador do cartão para a sua conta de estabelecimento.

Regras Principais

Se não for capturada em até 7 dias, a autorização é automaticamente cancelada (void) pelo sistema
O prazo de liquidação começa a contar a partir do momento da captura, não da autorização
Um pagamento só pode ser capturado uma vez (mas você pode capturar um valor parcial)
Se o pagamento foi criado com "capture": true, ele já foi capturado — tentar de novo retorna um erro
Se nenhum valor for especificado, o valor total autorizado é capturado

Endpoint

POST https://{FQDN}/payments/{externalPaymentId}/capture

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`
`Content-Type`	`application/json`

Corpo da Requisição (Opcional)

Omita o corpo para capturar o valor total autorizado. Inclua-o para uma captura parcial:

{
  "amount": {
    "total": 50.00,
    "currency": "USD"
  }
}

Campo	Tipo	Obrigatório	Descrição
`amount.total`	number	Não	Valor a capturar (deve ser ≤ valor autorizado)
`amount.currency`	string	Não	Código da moeda (deve corresponder ao da autorização)

Exemplo — Captura Total

curl -X POST https://{FQDN}/payments/order-12345/capture \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...' \
  -H 'Content-Type: application/json'

Exemplo — Captura Parcial

curl -X POST https://{FQDN}/payments/order-12345/capture \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": {
      "total": 50.00,
      "currency": "USD"
    }
  }'

Resposta (200)

{
  "paymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "parentPaymentId": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "externalPaymentId": "order-12345",
  "amount": 100.10,
  "created": "2024-04-22 16:22:06",
  "approved": true,
  "message": "Payment Approved",
  "automaticReversed": false,
  "status": "CAPTURED",
  "captured": true,
  "voided": false,
  "authCode": "bfb9eacb-7c72-4cc8-9cae-afd9164ec792",
  "issuerName": "BANK OF AMERICA",
  "issuerCountry": "US",
  "cvcResult": "APPROVED",
  "avsResult": "NOT_SENT"
}

Para capturas parciais, o status será PARTIALLY_CAPTURED.

O Que Vem a Seguir

Capturado? → Agora você pode reembolsar o pagamento (total ou parcial)
Mudou de ideia? → Apenas pagamentos não capturados podem ser cancelados (void)