Skip to main content
GET
/
v1
/
transfers
List Pix Transfers
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{
  "items": [
    {
      "id": "019c96a0-0c21-71f9-a487-66a1258278a1",
      "endToEndId": "E123456789BR1234567890123456789",
      "amount": "100.00",
      "status": "COMPLETED",
      "type": "CASHOUT",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "limit": 10,
  "offset": 0
}

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).

Query Parameters

​
limit
integer
default:10

Maximum number of items per page.

Required range: 1 <= x <= 100
​
offset
integer
default:0

The number of items to skip before starting to collect the result set.

​
sort_order
enum<string>
default:asc

Sort direction: asc or desc.

Available options:
asc,
desc
​
end_to_end
string

Filter by the Pix transfer end-to-end identifier.

​
status
enum<string>

Filter by the transfer status (PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED).

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
​
type
enum<string>

Filter by transfer direction (CASHOUT or CASHIN).

Available options:
CASHOUT,
CASHIN
​
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 Pix transfers retrieved successfully.

​
items
object[]
​
limit
integer
Example:

10

​
offset
integer
Example:

0