Storefront cashiers

Use these operations to access Storefront cashiers.

Cashiers are customer-scoped configuration resources that define the deposit and payout (withdrawal) settings for a specific customer, website, and currency.

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.

Important: These operations are experimental and may change.

Operations

Retrieve a cashier
Experimental

Request

Retrieves a cashier resource 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/cashiers/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Cashier retrieved.

Bodyapplication/json
idstring, <= 50 charactersrequired

Unique identifier of the cashier resource.

Example:"cashier_0YV7DE4Z26DQSA1AC92FBJ7SEG"
websiteIdstring, <= 50 characters(WebsiteId)required

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
currencystring, = 3 characters(CurrencyCode)required

Currency code in ISO 4217 format.

Example:"USD"
redirectUrlstring or null, (uri), <= 2083 charactersrequired

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

balancenumber, (double), >= 0read-onlyrequired

Customer's current balance.

Example:1500
bonusBalancenumber, (double), >= 0read-onlyrequired

Bonus balance available to the customer.

Example:1500
pendingPayoutTotalnumber, (double), >= 0read-onlyrequired

Sum of all payout requests that are currently in a pending state. This value is also the maximum possible "reverse withdrawal" amount.

Example:100
canWithdrawbooleanread-onlyrequired

Specifies if the customer can initiate a withdrawal.

depositMethodsArray of objects(ReadyToPayMethods)required
payoutMethodsArray of objectsrequired
depositAmountsArray of numbersrequired

List of predefined deposit amounts that the customer can choose from.

Example:
[
  10,
  20
]
depositCustomAmountobjectrequired

Custom amount restrictions. If this value is not specified, custom amounts are prohibited.

defaultDepositAmountnumber or null, (double), >= 0.01required

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

coinPurchasebooleanread-onlyrequired

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.

lastDepositRequestIdstring

ID of the last deposit request that is made for this cashier.

Example:"dep_req_01K2HMPNTBDS92TA6W4EX3VJPM"
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": "cashier_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "currency": "USD",
  "redirectUrl": "http://example.com",
  "balance": 1500,
  "bonusBalance": 1500,
  "pendingPayoutTotal": 100,
  "canWithdraw": true,
  "depositMethods": [
    { … }
  ],
  "payoutMethods": [
    { … }
  ],
  "depositAmounts": [
    10,
    20
  ],
  "depositCustomAmount": {
    "minimum": 10,
    "maximum": 1000,
    "multipleOf": 0.5,
    "buttonText": { … }
  },
  "defaultDepositAmount": 0.01,
  "coinPurchase": true,
  "lastDepositRequestId": "dep_req_01K2HMPNTBDS92TA6W4EX3VJPM",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}