# Retrieve deposit requests

Retrieves a list of deposit requests.

Endpoint: GET /deposit-requests
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

  - `expand` (string)
    Expands a request to include embedded objects within the 
property of the response. This field accepts a comma-separated list of objects.

For more information, see
Expand to include embedded objects.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the deposit request.
    Example: "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7"

  - `websiteId` (string, required)
    Website ID of the deposit. This value specifies the website with which the deposit is associated.
    Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

  - `customerId` (string, required)
    ID of the customer resource.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `transactionIds` (array)
    List of transaction IDs that are associated with the deposit request.
This list includes transactions that are created from the deposit request.
There is a maximum of one  transaction in the list.

  - `status` (string)
    Status of the request.
    Enum: "created", "pending", "initiated", "attempted", "completed", "expired"

  - `currency` (string, required)
    Currency code in ISO 4217 format.
    Example: "USD"

  - `amounts` (array)
    List of available deposit amounts.

If  is not specified when a deposit is created, amounts are determined from the chosen deposit amount strategy.
For more information, see the [ property](https://www.rebilly.com/catalog/all/deposits/postdepositrequest#deposits/postdepositrequest/t=request&path=strategyid).

  - `customAmount` (object,null)
    Custom amount restrictions.
If this value is ,  custom amounts are prohibited.
If  is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy.
For more information, see the [ property](https://www.rebilly.com/catalog/all/deposits/postdepositrequest#deposits/postdepositrequest/t=request&path=strategyid).

  - `customAmount.minimum` (number, required)
    Minimum custom amount.

  - `customAmount.multipleOf` (number, required)
    Multiple by which the custom amount increases.

For example, if  is equal to 5.30, and  is 0.50, the valid custom amount is 5.30, 5.80, 6.30, 6.80 and so on until the  value is reached.

A valid custom amount must be equal to  + X * , where X is any non negative integer.

  - `customAmount.maximum` (number, required)
    Maximum custom amount. This value must be equal to  + X * , where X is any positive integer.

  - `redirectUrl` (string)
    URL to redirect the customer to when a deposit is completed. The default value is the website URL.

  - `expirationTime` (string)
    Date and time at which the deposit request expires. The default expiration time is one hour from the time the request is created.

  - `propertiesSchema` (object,null)
    Defines properties the user can complete when they use the hosted deposit form.
This field accepts [JSON-schema](https://json-schema.org/) drafts 4, 6, and 7.
    Example: {"type":"object","properties":{"email":{"type":"string"},"max":{"type":"integer","minimum":0,"exclusiveMaximum":100}},"required":["email"]}

  - `properties` (object,null)
    Properties that are available for the user to complete when they use the hosted deposit form.
Use this object to describe fields that are rendered and completed on the hosted deposit form.
    Example: {"email":"email@example.com","max":"33"}

  - `notificationUrl` (string,null)
    URL where a server-to-server POST notification is sent.
This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.

Do not interpret this notification as a confirmation,
complete a  request to confirm the result of the transaction.
To ensure the request is not reattempted,
when the result is confirmed, respond with a  HTTP status code.

The following placeholders are available to use in this URI:  and .
These placeholders are replaced the with the transaction ID and result accordingly.

  - `cashierToken` (string,null)
    JSON Web Token (JWT) used to complete the deposit request.
This value is  if the deposit request is  or .

  - `customFields` (object)
    Use custom fields to extend a resource scheme to include custom data that is not provided as a common field.
For more information, see [Custom fields](https://www.rebilly.com/catalog/all/custom-fields).
    Example: {"foo":"bar"}

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "deposit", "transactions"

  - `_embedded` (object)
    Embedded objects that are requested by the  query parameter.

  - `_embedded.customer` (object)

  - `_embedded.website` (object)

  - `_embedded.transactions` (array)
    Most recent associated transactions.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.