Pular para o conteúdo principal
POST
/
credit-card
/
v1
/
payment
/
{paymentId}
/
cancel-capture
Cancelar Pré-Autorização
curl --request POST \
  --url https://api-gateway.firebanking.dev/credit-card/v1/payment/{paymentId}/cancel-capture \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "status": "<string>",
  "amount": 123,
  "installments": 123,
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}
Cancelar um pagamento pré-autorizado que ainda não foi capturado. Isso libera a reserva no cartão do cliente sem cobrá-lo.

​
Parâmetros de Caminho

​
paymentId
string
required
O identificador único do pagamento pré-autorizado a ser cancelado

​
Requisitos

  • Pagamento deve estar com status authorized
  • Pagamento ainda não deve ter sido capturado
  • Pré-autorização deve ainda estar ativa (não expirada)

​
Exemplo de Requisição

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

​
Exemplo de Resposta

Resposta
{
  "id": "payment-123",
  "status": "cancelled",
  "amount": 10000,
  "installments": 1,
  "externalId": "ext-payment-12345",
  "captured": false,
  "cancelled": true,
  "cancelledAt": "2024-01-15T15:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Quando Usar

Cancelamento de Pedido

Cliente cancela seu pedido antes da entrega

Problemas de Estoque

Produto está fora de estoque ou indisponível

Verificação Falhada

Cliente falha na verificação de identidade ou fraude

Regras de Negócio

Pedido não atende aos requisitos de negócio
Cancelar uma pré-autorização libera imediatamente a reserva no cartão do cliente. Os fundos ficam disponíveis novamente para eles dentro de 1-2 dias úteis.
Uma vez que uma pré-autorização é cancelada, ela não pode ser capturada. Você precisaria criar um novo pagamento se quiser cobrar o cliente.

​
Cancelamento Automático

Pré-autorizações expiram automaticamente após um determinado período (normalmente 7 dias para cartões de crédito, 3 dias para cartões de débito). No entanto, é uma boa prática cancelá-las explicitamente quando você souber que não serão capturadas.

​
Cenários de Erro

  • Pagamento não encontrado: O ID do pagamento não existe
  • Já capturado: Não é possível cancelar um pagamento que já foi capturado
  • Já cancelado: Pagamento já foi cancelado
  • Autorização expirada: Pré-autorização já expirou

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação

Path Parameters

​
paymentId
string
required

ID do pagamento a cancelar

Response

200 - application/json

Pré-autorização cancelada 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