Experimental Create a cashier strategy

Creates a cashier strategy. To complete the deposit, the customer is redirected to the cashier link. After the deposit, the customer is redirected to the redirectUrl. Corresponding transaction webhooks are sent to webhooks subscribers.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Cashier strategy resource.

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.

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.

Responses
201

Cashier strategy created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
id
string <= 50 characters

ID of the cashier strategy.

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.

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.

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.

422

Invalid data sent.

post/cashier-strategies
Request samples
application/json
{
  • "name": "string",
  • "filter": "cashierRequest.currency:USD",
  • "amounts": {
    },
  • "customAmount": {
    }
}
Response samples
application/json
{
  • "id": "cash_str_0YVJ64MAHTDPA97H8S7R5MYR1M",
  • "name": "string",
  • "filter": "cashierRequest.currency:USD",
  • "amounts": {
    },
  • "customAmount": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z"
}