Skip to main content
POST
/
api
/
pix
/
refund-in
/
{id}
Solicitar estorno de pagamento recebido (Refund-In)
curl --request POST \
  --url https://api.avista.global/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"
}

Authorizations

​
Authorization
string
header
required

Enter JWT token

Path Parameters

​
id
string
required

ID da transação original a ser estornada

Example:

"123"

Body

application/json
​
refundValue
number
required

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

Required range: x >= 0.01
Example:

50

​
reason
string

Motivo do estorno (opcional)

Example:

"Cliente solicitou devolução"

​
externalId
string

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

Example:

"D123456789"

Response

Solicitação de estorno realizada com sucesso

​
transactionId
number
required

ID da transação de estorno gerada

Example:

789

​
externalId
string
required

ID externo da transação de estorno

Example:

"D123456789"

​
status
enum<string>
required

Status atual da transação de estorno

Available options:
PENDING,
CONFIRMED,
ERROR
Example:

"PENDING"

​
refundValue
number
required

Valor do estorno em reais

Example:

50

​
providerTransactionId
string
required

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

Example:

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

​
generateTime
string
required

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

Example:

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