APIs
Sub-processorsAbout PismoContact us

Create customer flex control

post
https://sandbox.pismolabs.io/rules/v1/customers//flex-controls

Creates flex control for customer. You use flex controls to restrict financial operations. For example, you can set spending and usage limits. See Flexible transaction controls for more information.

To create a cumulative condition, the type can be:

  • spending_limit to restrict the maximum total amount that can be transacted during an specific period.
  • usage_limit to evaluate the quantity of transactions. The cumulative control type must also specify the max_limit. The limit_duration and reset_period parameters are optional, but they are linked with the behavior of max_limit.

To create a restriction condition, set type as restriction.

To restrict an operation, the restriction control must specify:

  • at least one condition in the conditions array.
  • the required values for attribute, operator, and value in the condition.

Once you create the control, you can't change its type.

This endpoint generates a Customer flex control created event.

NOTE: This endpoint requires an account-specific access token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

Customer ID

Body Params
string
enum
required

Flex control scope

  • usage_limit: Accumulator flex control that increases by one until max_limit
  • spending_limit: Accumulator flex control that increases by the current transaction's amount until max_limit
  • restriction: Restriction flex control that only validates specified conditions
  • cumulative_limit: Accumulator flex control that increases by one until a condition is met, applies only to flex controls with associated card_ids, and requires a reset_strategy
Allowed:
processing_codes
array of strings

Processing codes list for evaluating flex control conditions. If the value is empty, the flex control applies to any processing code.

processing_codes
string

If rule_reference_id is set, this program-level flex control, if it exists, overrides this flex control.

string
required

Flex control name

int64
required

Account ID

string

Flex control currency code (ISO 4217)

int64
≥ 1

Maximum spending limit. Once met or exceeded, any subsequent transactions are declined by evaluation control flow. Note that this value is an integer. Since global currencies vary in the number of digits that are allowed after the decimal point, you must convert the actual maximum spending limit into an integer value to use in this field. To do this, use the following formula.

value = floatNumber × 10^X, where X is the number of digits after the decimal separator for the currency as defined in ISO 4217.

For example, if you want to set the value 499.99 for BRL currency transactions, where the number of decimal places is 2, you must set it to 49999 (499.99 × 10²).

If you want to set the value 499 for JPY currency transactions, where the number of decimal places is 0, you must set it to 4999 (4999.0 × 10^0 = 4999.0 × 1 - in other words, the value doesn't change.)

This field is REQUIRED for cumulative controls.

int64
≥ 1

Maximum number of transactions allowed. Once met or exceeded, subsequent transactions are declined by the evaluation control flow.

int64
≥ 1

Maximum accumulated amount allowed. Once met or exceeded, subsequent transactions are declined by the evaluation control flow. Note that the value must be calculated as follows.

value = floatNumber × 10^X, where X is the number of digits after the decimal separator for the currency defined in ISO 4217.

For example, if you want to set the value 499.99 for USD currency transactions, where the number of decimal places is 2, you must set the value to 49999 (499.99 × 10²).

If you want to set the value 499 for JPY currency transactions, where the number of decimal places is 0, you must set the value to 499 (499.0 × 10^0 = 499.0 × 1 - in other words, the value doesn't change).

string

Flex control limit period duration (ISO 8601 format). For example, if a flex control sets a spending limit of $500, and limit_duration is set to one month (P1M), then the user cannot spend more than $500 from the account in any one month period. If limit_duration is not set, then the flex control does not accumulate.

date-time
deprecated

Note: This field has been deprecated, use reset_period instead. The reset datetime (RFC-3339 format) of the control rule.

string

IANA Time Zone database, such as "America/New_York". This attribute is used to evaluate the flex control using the desired time zone for condition attributes such as week_day, month_day, time_now, and reset_period. If time_zone is empty, the control is evaluated using the UTC time zone.

reset_period
object

Enables the specification of reset periods for accumulators based on the duration in limit_duration. When this field is set, it must follow the RFC 3339 pattern from ISO 8601. When reset_period changes, the avaliable_limit is reset.

reset_strategy
object

The strategy to reset the accumulators.

card_ids
array of int64s

List of card IDs

card_ids
conditions
array of objects
conditions
boolean
Defaults to true

If not specified, defaults to 'true'. If set to 'false', the flex control is skipped during evaluation.

string

Deny code related to restriction. This code is returned when the evaluation does not meet the conditions.

string
length between 2 and 2

Alphanumeric two-character response code. This can be the standard card network response code. When the platform denies a transaction, it returns the response code that provides the precise reason for the denial by the card network.

string
length between 1 and 3

Alphanumeric three-character custom code. This can be an alternative custom code. When the platform denies a control evaluation, it returns the custom code that provides the precise reason for the denial by the anti-fraud solution.

int64
1 to 99

Order in which the control is evaluated. If this value is not provided, the control is evaluated after the controls with the configured evaluation_order value.

string
enum

Specifies the operational mode of the card.

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago