Pular para o conteúdo principal
POST
/
credit-card
/
v1
/
payment
/
{paymentId}
/
capture
Capturar Pagamento
curl --request POST \
  --url https://api-gateway.firebanking.dev/credit-card/v1/payment/{paymentId}/capture \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "status": "<string>",
  "amount": 123,
  "installments": 123,
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}
Capturar um pagamento previamente pré-autorizado. Este endpoint é usado quando você inicialmente cria um pagamento com capture: false e deseja completar a transação posteriormente.

​
Parâmetros de Caminho

​
paymentId
string
required
O identificador único do pagamento a ser capturado

​
Fluxo de Pré-Autorização

  1. Criar Pagamento com capture: false
  2. Verificar os detalhes do pagamento e informações do cliente
  3. Capturar Pagamento usando este endpoint para completar a transação

​
Exemplo de Requisição

cURL
curl -X POST "https://api-gateway.firebanking.com.br/credit-card/v1/payment/payment-123/capture" \
  -H "x-api-key: SUA_CHAVE_DE_API"

​
Exemplo de Resposta

Resposta
{
  "id": "payment-123",
  "status": "completed",
  "amount": 10000,
  "installments": 1,
  "externalId": "ext-payment-12345",
  "captured": true,
  "capturedAt": "2024-01-15T10:31:00Z",
  "createdAt": "2024-01-15T10:30:00Z"
}
Você só pode capturar pagamentos que estão com status authorized. Pagamentos já capturados ou que falharam não podem ser capturados novamente.
A pré-autorização é útil para cenários como reservas de hotel, onde você deseja verificar a validade do cartão antes de completar a cobrança.

​
Casos de Uso Comuns

  • Reservas de Hotel: Pré-autorizar na reserva, capturar no check-in
  • Verificação de Pedido: Pré-autorizar durante o pedido, capturar na entrega
  • Configuração de Assinatura: Verificar validade do cartão antes de iniciar assinatura

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação

Path Parameters

​
paymentId
string
required

ID do pagamento a capturar

Response

200 - application/json

Pagamento capturado com sucesso

​
id
string

ID do pagamento

​
status
string

Status do pagamento

​
amount
integer

Valor do pagamento em reais

​
installments
integer

Número de parcelas

​
externalId
string

ID de referência externa

​
createdAt
string<date-time>

Timestamp de criação