[POST] /payment/:id/refund

Solicita o reembolso de uma cobrança

Premissas para realizar um reembolso com sucesso

Uma ordem de cobrança só pode ser reembolsada caso ela esteja com status PAGO (PAID)

Uma ordem de cobrança só pode ser reembolsado caso caso tenha saldo suficiente disponível na conta

Endpoints

Método POST

Sandbox (firebanking.dev)

https://api-gateway.firebanking.dev/credit-card/v1/payment/<id>/refund

Produção (firebanking.com.br)

https://api-gateway.firebanking.com.br/credit-card/v1/payment/<id>/refund

Requisição

Headers

Campo	Valor	Tipo	Descrição
Content-Type	application/json	string	Define o conteúdo como JSON
x-api-key	123	string	Sua chave API

Parâmetros da rota

Campo	Obrigatório	Descrição
id	Sim	Identificador único da transação. Pode ser informado tanto o `internalId` quanto o `externalId` para pesquisar.

cURL

curl --request POST \
  --url 'https://api-gateway.firebanking.dev/credit-card/v1/payment/:id/refund' \
  --header 'x-api-key: <sua-chave-api>'

Exemplo de resposta

Campos a serem recebidos

Campo	Descrição
message	Descritivo do status da operação
paymentId	ID da ordem de cobrança
refundedCharges	Lista de cobranças que sofreram com reembolso e tiveram sucesso
refundedCharges.id	ID da cobrança
refundedCharges.status	Status da cobrança
refundedCharges.refundDate	Timestamp do reembolso da cobrança
failedCharges	Lista de cobranças que tentaram reembolso e tiveram alguma falha
refundedAt	Timestamp do momento em que todos os reembolsos foram realizados

JSON

{
	"message": "Payment refunded successfully. 1 charges refunded, 0 failed",
	"paymentId": "f416740c-3a7d-49ec-b0bf-030ac00ad2f9",
	"refundedCharges": [
		{
			"id": "d489a045-0985-41e4-bad3-c87f4102e03d",
			"status": "REFUNDED",
			"refundDate": "2025-08-06T21:15:08.390Z"
		}
	],
	"failedCharges": [],
	"refundedAt": "2025-08-06T21:15:45.131Z"
}