logo

Retrieve deposit requests

Retrieves a list of deposit requests.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

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 of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

List of deposit requests retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
websiteId
required
string <= 50 characters

Website ID of the deposit. This value specifies the website with which the deposit is associated.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

id
string <= 50 characters

ID of the deposit request.

transactionId
string or null <= 50 characters

ID of the transaction that is used in the deposit request.

status
string

Status of the request.

Enum: Description
created

Request is created, but it has not been visited by a customer. This is a temporary state.

pending

Request has been visited by a customer, but no funds have been deposited yet. This is a temporary state.

completed

A funds deposit transaction has been initiated. This is a permanent state.

expired

Request expired without a deposit attempt. This is a permanent state.

amounts
Array of numbers <double>

List of available deposit amounts.

If amounts is not specified when a deposit is created, amounts are determined from the chosen strategy. For more information, see the strategyId property.

object or null

Custom amount restrictions. If this value is null, custom amounts are prohibited. If customAmount is not specified when a deposit request is created, amount restrictions are determined from the chosen strategy. For more information, see the strategyId property.

minimum
required
number <double> >= 0.01

Minimum custom amount.

multipleOf
required
number <double> >= 0.01

Multiple by which the custom amount increases.

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

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

maximum
required
number <double> >= 0.01

Maximum custom amount. This value must be equal to minimum + X * multipleOf, where X is any positive integer.

redirectUrl
string <uri>

URL to redirect the customer to when a deposit is completed. The default value is the website URL.

expirationTime
string <date-time>

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 or null

Defines properties the user can complete when they use the hosted deposit form. This field accepts JSON-schema drafts 4, 6, and 7.

object or 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.

property name*
additional property
string
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "deposit" "transaction"
object

Embedded objects that are requested by the expand query parameter.

customer
object
website
object
transaction
object
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/deposit-requests
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Retrieve a deposit request