Pular para o conteúdo principal
POST
/
credit-card
/
v1
/
payment
/
{paymentId}
/
refund
Estornar Pagamento
curl --request POST \
  --url https://api-gateway.firebanking.dev/credit-card/v1/payment/{paymentId}/refund \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "status": "<string>",
  "amount": 123,
  "installments": 123,
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}
Emitir um estorno completo para um pagamento concluído. Isso retornará o valor total do pagamento para o método de pagamento original do cliente.

​
Parâmetros de Caminho

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

​
Requisitos

  • Pagamento deve estar com status completed
  • Pagamento deve ter sido capturado
  • Estorno deve ser solicitado dentro do prazo permitido (normalmente 120 dias)

​
Exemplo de Requisição

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

​
Exemplo de Resposta

Resposta
{
  "id": "payment-123",
  "status": "refunded",
  "amount": 10000,
  "installments": 1,
  "externalId": "ext-payment-12345",
  "refunded": true,
  "refundedAt": "2024-01-16T14:30:00Z",
  "refundAmount": 10000,
  "createdAt": "2024-01-15T10:30:00Z"
}

​
Tempos de Processamento do Estorno

Cartões de Crédito

2-10 dias úteis dependendo da bandeira do cartão

Cartões de Débito

1-5 dias úteis dependendo do banco
Estornos são irreversíveis. Certifique-se de verificar a solicitação de estorno antes de processar.
O cliente verá o estorno em seu extrato com o mesmo nome do comerciante da cobrança original.

​
Estornos Parciais

Atualmente, apenas estornos completos são suportados. Se você precisar estornar um valor parcial, entre em contato com nossa equipe de suporte.

​
Cenários de Erro

  • Pagamento não encontrado: O ID do pagamento não existe
  • Pagamento não elegível: Pagamento não está em estado que permite estorno
  • Já estornado: Pagamento já foi estornado
  • Janela de estorno expirada: Pagamento é muito antigo para ser estornado

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação

Path Parameters

​
paymentId
string
required

ID do pagamento a estornar

Response

200 - application/json

Pagamento estornado 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