/
Retrieve deposit amount s...

Retrieve deposit amount strategies
Experimental

Request

Retrieves a list of deposit amount strategies.

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

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

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

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

Responses

List of deposit amount strategies retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

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 amount strategy.

Example:"dep_str_0YVJ64MAHTDPA97H8S7R5MYR1M"
namestringrequired

Name of the deposit amount strategy.

filterstring

Filter that uses deposit request properties to determine if a deposit amount strategy is applicable for the deposit request. If this field is empty, the deposit amount strategy is applicable for any request.

Default:""
Example:"depositRequest.currency:USD"
amountsobjectrequired

Amounts configuration for deposit amount strategy.

customAmountobject or nullrequired

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 deposit amount strategy. For more information, see the strategyId property.

priorityinteger, >= 0

Non-negative integer value that specifies which deposit amount strategy is applied to the request. The deposit amount strategy with the highest priority value is applied.

Default:0
isActiveboolean

Specifies if the deposit amount strategy is active.

Default:true
coinPricingCoinPricing (object) or null
One of:

Formula for calculating the number of coins to credit to the coin balance based on a paid amount in fiat currency.

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.

coinPurchasebooleandeprecated

Specifies if deposits created from this strategy are coin purchases that credit the coin balance instead of the cash balance. Use the coinPricing field instead.

Default:false
]
Response
[
  {
    "id": "dep_str_0YVJ64MAHTDPA97H8S7R5MYR1M",
    "name": "string",
    "filter": "depositRequest.currency:USD",
    "amounts": { … },
    "customAmount": { … },
    "priority": 0,
    "isActive": true,
    "coinPurchase": false,
    "coinPricing": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]