Pular para o conteúdo principal
POST
/
v1
/
dict
/
refund-requests
/
{refund_id}
/
close
Encerrar uma Solicitação de Devolução
curl --request POST \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests/{refund_id}/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refundAnalysisResult": "TOTALLY_ACCEPTED",
  "refundAnalysisDetails": "Analysis confirms fraud. Refund approved."
}
'
{
  "id": "019c96a0-0c6b-7166-8510-b262039b4838",
  "transactionId": "E12345678202411241430ABCDEFGHIJK",
  "amount": "150.00",
  "status": "OPEN",
  "analysisResult": "TOTALLY_ACCEPTED",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Autorizações

​
Authorization
string
header
obrigatório

Header de autenticação Bearer no formato Bearer <token>, onde <token> é o seu token de acesso JWT.

Parâmetros de caminho

​
refund_id
string
obrigatório

Identificador único da solicitação de devolução (formato UUID).

Corpo

application/json
​
refundAnalysisResult
enum<string>
obrigatório

Resultado da análise.

Opções disponíveis:
TOTALLY_ACCEPTED,
PARTIALLY_ACCEPTED,
REJECTED
Exemplo:

"TOTALLY_ACCEPTED"

​
refundAnalysisDetails
string

Comentários da análise.

Exemplo:

"Analysis confirms fraud. Refund approved."

​
refundRejectionReason
enum<string>

Motivo da rejeição (se rejeitado).

Opções disponíveis:
NO_BALANCE,
ACCOUNT_CLOSURE,
INVALID_REQUEST,
OTHER
​
refundTransactionId
string

ID da transação para execução da devolução.

Exemplo:

"E98765432202411241500REFUNDTRANS"

Resposta

Solicitação de devolução encerrada com sucesso.

​
id
string

Identificador único.

Exemplo:

"019c96a0-0c6b-7166-8510-b262039b4838"

​
transactionId
string

ID da transação original.

Exemplo:

"E12345678202411241430ABCDEFGHIJK"

​
amount
string

Valor da devolução.

Exemplo:

"150.00"

​
status
enum<string>

Status atual.

Opções disponíveis:
OPEN,
CLOSED,
CANCELLED
Exemplo:

"OPEN"

​
analysisResult
string

Resultado da análise.

Exemplo:

"TOTALLY_ACCEPTED"

​
createdAt
string<date-time>
Exemplo:

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

​
updatedAt
string<date-time>
Exemplo:

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