List Pix Deposits

GET 
/v5/pix/deposits

Get a list of user's pix deposits. You can include any of the filter parameters below to refine your search.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [created_at]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

created_at_period_start date-time

Created at period date start for any transaction.

created_at_period_end date-time

Created at period date end for any transaction.

end_to_end_id string

PixDeposit end to end id

txid string

PixDeposit tx identifier

states string[]

Possible values: [NEW, RECEIVED, WAITING, ERROR, BLOCKED]

PixDeposit State.

Header Parameters

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-product-uuid string

The product ID is a UUID (v4) used to identify the Z.ro product configuration.

x-product-target-user-uuid string

The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses

200

The deposits returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
PixDeposits data.
Array [
id stringrequired
Deposit ID.
operation_id stringrequired
Operation ID.
type stringrequired
Possible values: [DEVOLUTION_COMPLETED, DEVOLUTION_RECEIVED, DEPOSIT_RECEIVED, PAYMENT_COMPLETED]
Transaction type.
state stringrequired
Possible values: [NEW, RECEIVED, WAITING, ERROR, BLOCKED]
Deposit state.
end_to_end_id stringrequired
End to end id.
txid string
Payment txid identifier.
amount numberrequired
Deposit R$ in cents.
available_amount numberrequired
Deposit available amount.
owner_name string
The payment owner name.
owner_person_type stringrequired
Possible values: [CPF, CNPJ]
The payment owner person document type.
owner_document string
The payment owner document.
owner_bank_name stringrequired
The payment owner bank name.
owner_bank_ispb string
The payment owner bank ispb.
beneficiary_name string
The payment beneficiary name.
beneficiary_account_number stringrequired
The payment beneficiary account number.
beneficiary_branch_number stringrequired
The payment beneficiary account branch number.
beneficiary_person_type stringrequired
Possible values: [CPF, CNPJ]
The payment beneficiary person document type.
beneficiary_document string
The payment beneficiary document.
beneficiary_bank_name stringrequired
The payment beneficiary bank name.
beneficiary_bank_ispb string
The payment beneficiary bank ispb.
created_at date-timerequired
Deposit created at.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "operation_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "type": "DEVOLUTION_COMPLETED",
      "state": "RECEIVED",
      "end_to_end_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "txid": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "amount": 1299,
      "available_amount": 1299,
      "owner_name": "string",
      "owner_person_type": "CPF",
      "owner_document": "string",
      "owner_bank_name": "string",
      "owner_bank_ispb": "string",
      "beneficiary_name": "string",
      "beneficiary_account_number": "12376786",
      "beneficiary_branch_number": "12376786",
      "beneficiary_person_type": "CPF",
      "beneficiary_document": "string",
      "beneficiary_bank_name": "string",
      "beneficiary_bank_ispb": "string",
      "created_at": "2025-05-07T20:37:54.191Z"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://docs.zrobank.io/v5/pix/deposits' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Auth

Bearer Token

Parameters

nonce — headerrequired

page — query

size — query

sort — query

---created_at

order — query

---ascdesc

created_at_period_start — query

created_at_period_end — query

end_to_end_id — query

txid — query

states — query

NEWRECEIVEDWAITINGERRORBLOCKED

x-wallet-uuid — header

x-lang — header

---pt-BRen-US

x-product-uuid — header

x-product-target-user-uuid — header

ResponseClear

Click the Send API Request button above and see the response here!