List deposits
GET {{baseUrl}}/{{version}}/deposit
Deposits represent passive cash-ins received by your account from external transfers or payments. In this section, we will teach you how to manage your Deposits.
Here you can list and filter all deposits you have made. We return it paged.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
cursor | null | String used to get the next batch of results. Our SDKs handle this for you. | |
limit | null | Number of results per cursor. Max = 100. | |
after | null | Filter entities created after this date. | |
before | null | Filter entities created before this date. | |
status | null | Filter deposits by the specified status. | |
sort | null | Sort order considered in the response. Options are: "created", "-created". | |
tags | null | Filter entities that contain the specified tags. | |
ids | null | List of deposits IDs linked to the desired deposits. | |
fields | null | List of strings to filter response JSON keys. Not available in the SDKs. |
RESPONSES
status: OK
{"cursor":null,"deposits":[{"status":"created","updated":"2020-11-16T03:56:17.040220+00:00","accountNumber":"3731460","taxId":"95.380.472/0001-23","accountType":null,"transactionIds":["5670419491192832"],"bankCode":"30306294","id":"5721207605297152","fee":50,"name":"EMPRESA DE MEIOS DE PAGAMENTOS LTDA","created":"2020-11-16T03:56:15.449640+00:00","tags":[],"branchCode":"1","amount":1999,"type":"pix"},{"status":"created","updated":"2020-10-31T04:06:02.065298+00:00","accountNumber":"3731460","taxId":"16.707.495/0001-23","accountType":null,"transactionIds":["5682621057073152"],"bankCode":"30306294","id":"5634161670881280","fee":0,"name":"EMPRESA DE MEIOS DE PAGAMENTOS LTDA","created":"2020-10-31T03:51:40.411834+00:00","tags":[],"branchCode":"1","amount":1399,"type":"pix"}]}