Retrieve cashier strategies

Retrieves a list of cashier strategies.

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

Limits the number of collection items to be returned.

offset
integer >= 0

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 cashier strategies 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
name
required
string

Name of the strategy.

filter
required
string
Default: ""

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

required
object (CashierStrategyAmounts)

Cashier strategy amounts configuration.

calculator
required
string

Cashier amounts calculator. This field specifies if amounts are calculated using an absolute or percentage calculation.

Amounts are specified in baseAmount, and increments are specified in increments.

Example: baseAmount: 10 and increments: [20, 50, 100].

  • If the calculator is set to absolute: the amounts displayed to the customer are [10, 30, 60, 110].
  • If the calculator is set to percent: the amounts displayed to the customer are [10, 12, 15, 20].
Enum: "absolute" "percent"
baseAmount
required
number <double> >= 0.01

First amount that is displayed to customer.

increments
required
Array of numbers <double>

List of incremental amounts that are displayed to customer.

For more information, see the calculator property.

adjustBaseToLastDeposit
boolean
Default: false

Specifies if the base amount must be adjusted based on the last deposit. If this value is true, the baseAmount is changed to the last successful deposit amount made using Create a cashier request.

If the customer has no successful deposits, baseAmount is not adjusted.

required
object or null (CashierStrategyCustomAmount)

Custom amount restrictions. If this value is null, custom amounts are prohibited. If customAmount is not specified when a cashier 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.

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

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.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/cashier-strategies
Request samples
Response samples
application/json
[
  • {
    }
]