Pular para o conteúdo principal
POST
/
api
/
pix
/
refund-in
/
{id}
Solicitar estorno de pagamento recebido (Refund-In)
curl --request POST \
  --url https://api.public.firebanking.com.br/api/pix/refund-in/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refundValue": 50,
  "reason": "Cliente solicitou devolução",
  "externalId": "D123456789"
}
'
{
  "transactionId": 789,
  "externalId": "D123456789",
  "status": "PENDING",
  "refundValue": 50,
  "providerTransactionId": "7ef4fc3f-a187-495e-857c-e84d70612761",
  "generateTime": "2024-01-15T10:30:00.000Z"
}

Autorizações

​
Authorization
string
header
obrigatório

Enter JWT token

Parâmetros de caminho

​
id
string
obrigatório

ID da transação original a ser estornada

Exemplo:

"123"

Corpo

application/json
​
refundValue
number
obrigatório

Valor a ser estornado em reais (pode ser parcial). Deve ser menor ou igual ao valor disponível para estorno

Intervalo obrigatório: x >= 0.01
Exemplo:

50

​
reason
string

Motivo do estorno (opcional)

Exemplo:

"Cliente solicitou devolução"

​
externalId
string

ID externo para identificação da devolução. Na API BACEN, corresponde ao parâmetro 'id' da URL

Exemplo:

"D123456789"

Resposta

Solicitação de estorno realizada com sucesso

​
transactionId
number
obrigatório

ID da transação de estorno gerada

Exemplo:

789

​
externalId
string
obrigatório

ID externo da transação de estorno

Exemplo:

"D123456789"

​
status
enum<string>
obrigatório

Status atual da transação de estorno

Opções disponíveis:
PENDING,
CONFIRMED,
ERROR
Exemplo:

"PENDING"

​
refundValue
number
obrigatório

Valor do estorno em reais

Exemplo:

50

​
providerTransactionId
string
obrigatório

ID da transação no provedor (usado para correlação com webhooks)

Exemplo:

"7ef4fc3f-a187-495e-857c-e84d70612761"

​
generateTime
string
obrigatório

Data/hora de geração da transação de estorno (ISO 8601)

Exemplo:

"2024-01-15T10:30:00.000Z"