/
Create a deposit amount s...

Create a deposit amount strategy
Experimental

Request

Creates a deposit amount strategy. Use deposit amount strategies to determine the amounts presented to customers in deposit forms, based on currency, customer segmentation (tags), or prior deposit behavior.

Selection of deposit amount strategy:

  • If more than one deposit amount strategy applies to a deposit request, the deposit amount strategy with the greater priority value is applied.
  • If the strategyId property is specified when a deposit request is created, the specified deposit amount strategy is applied. All other deposit amount strategies are ignored.

Default behavior:

  • If the customAmount property is not specified when a deposit request is created, amount restrictions are determined from the chosen deposit amount strategy.
  • If the amounts property is not specified when a deposit request is created, amounts are determined from the chosen deposit amount strategy.
Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Deposit amount strategy resource.

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
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/deposit-strategies \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "filter": "depositRequest.currency:USD",
    "amounts": {
      "calculator": "absolute",
      "baseAmount": 0.01,
      "increments": [
        0.01
      ],
      "defaultIndex": 0,
      "adjustBaseToLastDeposit": false,
      "hideBaseAmount": false,
      "minimumBaseAmount": 0.01
    },
    "customAmount": {
      "minimum": 0.01,
      "multipleOf": 0.01,
      "maximum": 0.01,
      "buttonText": {
        "en-US": "Other amount",
        "fr": "Montant personnalisé"
      }
    },
    "priority": 0,
    "isActive": true,
    "coinPurchase": false
  }'

Responses

Deposit amount strategy created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
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": [
    { … }
  ]
}