Skip to main content
GET
/
v1
/
deposits
List all deposits
curl --request GET \
  --url https://api.yorlet.com/v1/deposits \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "deposit",
      "amount": 123,
      "application": "<string>",
      "assignee": "<string>",
      "certificate": "<string>",
      "country": "<string>",
      "currency": "<string>",
      "customer": "<string>",
      "description": "<string>",
      "requirements": {
        "additional": [
          "<string>"
        ],
        "currently_due": [
          "<string>"
        ],
        "minimum": [
          "<string>"
        ]
      },
      "returned_at": 123,
      "scheme": {
        "certificate": "<string>",
        "registration_deadline": 123,
        "registration_number": "<string>"
      },
      "transferred_at": 123,
      "unit": "<string>",
      "account": "<string>",
      "deleted": false,
      "amount_refunded": 0,
      "handled_externally": false,
      "metadata": {},
      "returned": false,
      "transferred": false
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of deposits.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required