Skip to main content
GET
/
v1
/
refunds
/
{refund_id}
Get a Refund
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/refunds/{refund_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{
  "id": "019c96a0-0c53-7a8d-8e29-67971d96d0e3",
  "originalEndToEndId": "E123456789BR1234567890123456789",
  "returnEndToEndId": "D123456789BR1234567890123456789",
  "amount": "100.00",
  "status": "COMPLETED",
  "reason": "FR01",
  "createdAt": "2024-01-15T10:30:00Z"
}

Authorizations

Authorization
string
header
required

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

Headers

X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

Path Parameters

refund_id
string
required

Unique identifier of the refund request (UUID format).

Response

Refund details retrieved successfully.

id
string

Refund unique identifier.

Example:

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

originalEndToEndId
string

Original transfer E2E ID.

Example:

"E123456789BR1234567890123456789"

returnEndToEndId
string

Return transfer E2E ID.

Example:

"D123456789BR1234567890123456789"

amount
string

Refund amount.

Example:

"100.00"

status
string

Refund status.

Example:

"COMPLETED"

reason
string

Refund reason code.

Example:

"FR01"

createdAt
string<date-time>
Example:

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