/
Retrieve deposit requests

Retrieve deposit requests
Experimental

Request

Retrieves a list of deposit requests.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

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

expandstring

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Embedded resources.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/deposit-requests?limit=1000&offset=1000&filter=string&sort=string&expand=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of deposit requests retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the deposit request.

Example:"dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7"
websiteIdstring, <= 50 charactersrequired

ID of the website associated with the deposit.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
customerIdstring, <= 50 characters(CustomerId)required

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
transactionIdsArray of strings

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 approved transaction in the list.

statusstringread-only

Status of the request.

Enum ValueDescription
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.

initiated

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

attempted

A funds deposit transaction was attempted and declined. This is a temporary state.

completed

A funds deposit transaction has been approved and completed. This is a permanent state.

expired

Request expired without an approved deposit transaction. This is a permanent state.

coinPurchasebooleanread-only

Specifies if the deposit is a coin purchase that credits the coin balance instead of the cash balance. Determined by the deposit amount strategy that is applied to the deposit request.

currencystring, = 3 characters(CurrencyCode)required

Currency code in ISO 4217 format.

Example:"USD"
amountsArray of numbers

List of available deposit amounts.

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

defaultAmountnumber or null, (double), >= 0.01

Value of the default amount in the amounts list. This value is calculated from the defaultIndex property of the deposit strategy that is applied to the deposit request.

customAmountobject 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.

redirectUrlstring, (uri), <= 2083 characters

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

expirationTimestring, (date-time)

Date and time when the deposit request expires. The default expiration time is one hour from the time the request is created.

propertiesSchemaobject or nullread-only

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

Example:
{
  "type": "object",
  "properties": {
    "email": { … },
    "max": { … }
  },
  "required": [
    "email"
  ]
}
propertiesobject or nullread-only

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"
}
notificationUrlstring or null, (uri), <= 2083 characters

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 GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.

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

cashierTokenstring or nullread-only

JSON Web Token (JWT) used to complete the deposit request. This value is null if the deposit request is expired or completed.

customFieldsobject(ResourceCustomFields)

Custom fields related to the deposit request. Custom field values are copied to created transactions if matching custom fields (name, type) exist.

Default:{}
Example:
{
  "foo": "bar"
}
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "id": "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7",
    "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
    "transactionIds": [ … ],
    "status": "created",
    "coinPurchase": true,
    "currency": "USD",
    "amounts": [ … ],
    "defaultAmount": 0.01,
    "customAmount": { … },
    "redirectUrl": "http://example.com",
    "expirationTime": "2019-08-24T14:15:22Z",
    "propertiesSchema": { … },
    "properties": { … },
    "notificationUrl": "http://example.com",
    "cashierToken": "string",
    "customFields": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ],
    "_embedded": { … }
  }
]