Skip to main content
GET
/
v1
/
dict
/
refund-requests
List Refund Requests
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/refund-requests \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-44665544r001",
      "transactionId": "E12345678202411241430ABCDEFGHIJK",
      "amount": "150.00",
      "status": "OPEN",
      "analysisResult": "TOTALLY_ACCEPTED",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "limit": 10
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:10

Maximum number of items per page.

Required range: 1 <= x <= 100
​
page
integer
default:1

Page number for pagination.

Required range: x >= 1
​
sort_order
enum<string>
default:asc

Sort direction: asc or desc.

Available options:
asc,
desc
​
transaction_id
string

Filter by original Pix transaction ID (32 characters).

​
status
enum<string>

Filter by refund status.

Available options:
OPEN,
CLOSED,
CANCELLED
​
requesting_participant
string

Filter by requesting participant ISPB (8 digits).

​
contested_participant
string

Filter by contested participant ISPB (8 digits).

​
infraction_id
string

Filter by related infraction report ID (UUID).

​
analysis_result
enum<string>

Filter by refund analysis result.

Available options:
TOTALLY_ACCEPTED,
PARTIALLY_ACCEPTED,
REJECTED
​
refund_transaction_id
string

Filter by refund transaction ID (32 characters).

​
modified_after
string

Filter by records modified after this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

​
modified_before
string

Filter by records modified before this timestamp (RFC3339 format: 2024-01-15T10:30:00Z).

Response

List of refund requests retrieved successfully.

​
items
object[]
​
page
integer
Example:

1

​
limit
integer
Example:

10