Skip to main content
GET
Obter uma Devolução

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

X-Account-Id
string
obrigatório

Identificador único da Conta do Ledger Midaz (formato UUID).

Parâmetros de caminho

refund_id
string
obrigatório

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

Resposta

Detalhes da devolução recuperados com sucesso.

id
string

Identificador único do reembolso.

Exemplo:

"019c96a0-0c53-7a8d-8e29-67971d96d0e3"

originalEndToEndId
string

ID E2E da transferência original.

Exemplo:

"E123456789BR1234567890123456789"

returnEndToEndId
string

ID E2E da transferência de devolução.

Exemplo:

"D123456789BR1234567890123456789"

amount
string

Valor do reembolso.

Exemplo:

"100.00"

status
enum<string>

Status do reembolso.

Opções disponíveis:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
Exemplo:

"COMPLETED"

type
enum<string>

Tipo de reembolso.

Opções disponíveis:
CASHOUT,
CASHIN
Exemplo:

"CASHOUT"

description
string

Descrição opcional do reembolso.

Exemplo:

"Cliente relatou transação não autorizada"

accountId
string

Identificador da conta associada ao reembolso.

Exemplo:

"01989f9e-6508-79f8-9540-835be49fbd0d"

createdAt
string<date-time>
Exemplo:

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

updatedAt
string<date-time>
Exemplo:

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

ledger
object

Identificadores de transação e operação do ledger Midaz.

metadata
object

Atributos personalizados de chave-valor associados a este reembolso. Máximo de 50 chaves, chave com no máximo 100 caracteres, valor com no máximo 2000 caracteres.