Storefront deposits

Use these operations to access Storefront deposits.

Storefront operations interact directly with the customer, and provide the customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see Create a session with username and password and Exchange an authentication token. Storefront operations are intended to be used directly from an untrusted browser.

Operations

Retrieve a deposit amount strategy
Experimental

Request

Retrieves a deposit amount strategy with a specified ID.

Security
CustomerJWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/deposit-strategies/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Deposit amount strategy retrieved.

Bodyapplication/json
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
coinPurchaseboolean

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

Default:false
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.

Response
{
  "id": "dep_str_0YVJ64MAHTDPA97H8S7R5MYR1M",
  "name": "string",
  "filter": "depositRequest.currency:USD",
  "amounts": {
    "calculator": "absolute",
    "baseAmount": 0.01,
    "increments": [ … ],
    "defaultIndex": 0,
    "adjustBaseToLastDeposit": false,
    "hideBaseAmount": false,
    "minimumBaseAmount": 0.01
  },
  "customAmount": {
    "minimum": 0.01,
    "multipleOf": 0.01,
    "maximum": 0.01,
    "buttonText": { … }
  },
  "priority": 0,
  "isActive": true,
  "coinPurchase": false,
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}