POST /deposit-strategies

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.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the deposit amount strategy.
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"self"`
`priority`	Integer	No	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 value: 0
`name`	String	Yes	Name of the deposit amount strategy.
`updatedTime`	String	No	Date and time when the resource is updated. This value is set automatically when the resource is updated.
`filter`	String	No	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.
`createdTime`	String	No	Date and time when the resource is created. This value is set automatically when the resource is created.
`isActive`	Boolean	No	Specifies if the deposit amount strategy is active. Default value: true
`amounts`	Object	Yes	Amounts configuration for deposit amount strategy.
`amounts.increments[]`	Array	Yes	List of incremental amounts that are displayed to customer. For more information, see the `calculator` property.
`amounts.defaultIndex`	Integer	Yes	Index of the default amount in the amounts list that is displayed to the customer. Use it to specify which amount from the calculated amounts is preselected when the customer opens the deposit form. When `hideBaseAmount` is `true`, the 0 index refers to the first increment. Default value: 0
`amounts.calculator`	String	Yes	Deposit 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]`. Valid values: `"percent"` `"absolute"`
`amounts.minimumBaseAmount`	Number	No	Minimum value for the base amount. If the base amount of the last deposit is less than this value, this value is used as the base amount.
`amounts.baseAmount`	Number	Yes	First amount that is displayed to customer.
`amounts.adjustBaseToLastDeposit`	Boolean	No	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 deposit request. If the customer has no successful deposits, `baseAmount` is not adjusted. Default value: false
`amounts.hideBaseAmount`	Boolean	No	Specifies if the base amount is hidden in the deposit form options. If this value is `true`, the base amount is used to calculate increments but is not shown as a selectable option. Default value: false
`customAmount`	Object	Yes	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.
`customAmount.minimum`	Number	Yes	Minimum custom amount.
`customAmount.multipleOf`	Number	Yes	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.
`customAmount.maximum`	Number	Yes	Maximum custom amount. This value must be equal to `minimum` + X * `multipleOf`, where X is any positive integer.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.