Account flex control updated
This event occurs when an account flex control changes.
Generated by: Update account flex control
More information: Flexible transaction controls
Type: object
Domain: audit
Event: account_spending_limit_updated
Version: 1
email required
Title: The email of operator that registered address
Type: string
Min length: 1
Max length: 20
Example:
[email protected]
method required
Title: The HTTP Method of address register operation
Type: string
Min length: 1
Max length: 10
Example:
POST
object
Title: The object that represents the account spending limit update
Type: objectdeny_code required
Title: The deny code related to the restriction
Type: string
Min length: 1
Max length: 100
Example:
ERR_VAL_WEEK_DAYid required
Title: The spending limit ID
Type: string
Min length: 1
Max length: 96
Example:
b22bc8ae-b178-4370-8164-e21154d88d87name required
Title: The name of the account spending limit
Type: string
Min length: 1
Max length: 1024
Example:
Template nametype required
Title: Spending Limit type, can be usage_limit, spending_limit or restriction
Type: string
Min length: 1
Max length: 14
Example:
usage_limit
spending_limit
restrictionactive
Title: The active state of the account spending limit
Type: boolean
Example:
trueavailable_limit
Title: The available spending limit
Type: integer
Example:
10000conditions required
Type: array
attribute required
Title: The attribute to evaluate in the condition
Type: string
Min length: 1
Max length: 22
Example:
week_dayoperator required
Title: Conditions operators
Type: string
Min length: 1
Max length: 3
Example:
ninvalue required
Title: The value to compare
Type: string
Min length: 1
Max length: 1024
Example:
monday,tuesday,wednesday,thursday,fridaycurrency_code
Title: The currency code (ISO-4217) for the spending limit.
Type: string
Min length: 1
Max length: 3
Example:
BRLcustomized
Title: Customized describes if the spending control is managed by the user
Type: boolean
Example:
truedescription
Title: The description of the account spending limit
Type: string
Min length: 1
Max length: 400
Example:
Template rules for legal person.limit_duration
Title: The limit period duration (ISO 8601 format) for the spending limit
Type: string
Min length: 1
Max length: 5
Example:
P1Mmax_limit
Title: The maximum spending limit
Type: integer
Example:
10000processing_codes
Title: The processing codes list
Type: array
Min length: 1
Max length: 6
Example:[ "077707" ]reset_datetime
Title: The reset datetime (RFC-3339 format) of the control
Type: string
Example:
2022-03-08T21:19:55Z00:00reset_period
Title: The reset period for accumulators based on the duration in limit_duration
Type: objectmonth_day
Title: Month day to reset.
Type: integer
Example:
1week_day
Title: Week day to reset
Type: string
Min length: 1
Max length: 9
Example:
monday
tuesday
wednesday
thursday
friday
saturday
sundayutc_time
Title: Time - DEPRECATED
Type: string
Example:
12:59AMtime
Title: Time
Description: Time to reset the flex control in the time zone defined by the control. Include hours and minutes only and AM/PM.
Type: string
Min length: 1
Max length: 7
Example:
12:59AMrule_reference_id
Title: The template rule ID
Type: string
Min length: 1
Max length: 96
Example:
d68f8020-49ab-4c6d-a099-5ebe3867297dresponse_code
Title: Alphanumeric two-character response code. This can be the standard card network response code or an alternative custom response code. When the platform denies a control evaluation, it returns the response code that provides the precise reason for the denial by the card network or anti-fraud solution.
Type: string
Example:
FM
57
05
A1evaluation_order
Title: Order in which the control is evaluated. If this value is not provided, the control is evaluated after the controls with the configured
evaluation_ordervalue.
Type: integer
Example:
99
origin required
Title: The request origin of address register operation
Type: string
Min length: 1
Max length: 3
Example:
P2P
PAYMENTS
roles required
Type: array
uri required
Title: The URI of address register operation
Type: string
Min length: 1
Max length: 50
Example:
/v1/accounts/{accountId}/spending-limits/{spendingLimitId}
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Account flex control updated",
"description": "This event occurs when an account flex control changes. <br> Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/patch-v1-accounts-flex-control-1' target='_blank'>Update account flex control</a> <br> More information: <a href='https://developers.pismo.io/pismo-docs/docs/flex-controls' target='_blank'>Flexible transaction controls</a>",
"required": [
"email",
"method",
"object",
"origin",
"roles",
"uri"
],
"properties": {
"email": {
"title": "The email of operator that registered address",
"type": "string",
"minLength": 1,
"maxLength": 20,
"examples": [
"[email protected]"
]
},
"method": {
"title": "The HTTP Method of address register operation",
"type": "string",
"minLength": 1,
"maxLength": 10,
"examples": [
"POST"
]
},
"object": {
"title": "The object that represents the account spending limit update",
"type": "object",
"required": [
"deny_code",
"id",
"name",
"type"
],
"properties": {
"deny_code": {
"title": "The deny code related to the restriction",
"type": "string",
"minLength": 1,
"maxLength": 100,
"examples": [
"ERR_VAL_WEEK_DAY"
]
},
"id": {
"title": "The spending limit ID",
"type": "string",
"minLength": 1,
"maxLength": 96,
"examples": [
"b22bc8ae-b178-4370-8164-e21154d88d87"
]
},
"name": {
"title": "The name of the account spending limit",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"Template name"
]
},
"type": {
"title": "Spending Limit type, can be usage_limit, spending_limit or restriction",
"type": "string",
"minLength": 1,
"maxLength": 14,
"examples": [
"usage_limit",
"spending_limit",
"restriction"
]
},
"active": {
"title": "The active state of the account spending limit",
"type": "boolean",
"examples": [
true
]
},
"available_limit": {
"title": "The available spending limit",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
10000
]
},
"conditions": {
"title": "The account spending limit conditions",
"type": "array",
"items": {
"type": "object",
"required": [
"attribute",
"operator",
"value"
],
"properties": {
"attribute": {
"title": "The attribute to evaluate in the condition",
"type": "string",
"minLength": 1,
"maxLength": 22,
"examples": [
"week_day"
]
},
"operator": {
"title": "Conditions operators",
"type": "string",
"minLength": 1,
"maxLength": 3,
"examples": [
"nin"
]
},
"value": {
"title": "The value to compare",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"monday,tuesday,wednesday,thursday,friday"
]
}
}
}
},
"currency_code": {
"title": "The currency code (ISO-4217) for the spending limit.",
"type": "string",
"minLength": 1,
"maxLength": 3,
"examples": [
"BRL"
]
},
"customized": {
"title": "Customized describes if the spending control is managed by the user",
"type": "boolean",
"examples": [
true
]
},
"description": {
"title": "The description of the account spending limit",
"type": "string",
"minLength": 1,
"maxLength": 400,
"examples": [
"Template rules for legal person."
]
},
"limit_duration": {
"title": "The limit period duration (ISO 8601 format) for the spending limit",
"type": "string",
"minLength": 1,
"maxLength": 5,
"examples": [
"P1M"
]
},
"max_limit": {
"title": "The maximum spending limit",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
10000
]
},
"processing_codes": {
"title": "The processing codes list",
"type": "array",
"items": {
"title": "The processing code item",
"type": "string",
"minLength": 1,
"maxLength": 6,
"examples": [
"077707"
]
}
},
"reset_datetime": {
"title": "The reset datetime (RFC-3339 format) of the control",
"type": "string",
"examples": [
"2022-03-08T21:19:55Z00:00"
]
},
"reset_period": {
"title": "The reset period for accumulators based on the duration in limit_duration",
"type": "object",
"properties": {
"month_day": {
"title": "Month day to reset.",
"type": "integer",
"minimum": 1,
"maximum": 4294967295,
"examples": [
1
]
},
"week_day": {
"title": "Week day to reset",
"type": "string",
"minLength": 1,
"maxLength": 9,
"examples": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
},
"utc_time": {
"title": "Time - DEPRECATED",
"type": "string",
"examples": [
"12:59AM"
]
},
"time": {
"title": "Time",
"description": "Time to reset the flex control in the time zone defined by the control. Include hours and minutes only and AM/PM.",
"type": "string",
"minLength": 1,
"maxLength": 7,
"examples": [
"12:59AM"
]
}
}
},
"rule_reference_id": {
"title": "The template rule ID",
"type": "string",
"minLength": 1,
"maxLength": 96,
"examples": [
"d68f8020-49ab-4c6d-a099-5ebe3867297d"
]
},
"response_code": {
"title": "Alphanumeric two-character response code. This can be the standard card network response code or an alternative custom response code. When the platform denies a control evaluation, it returns the response code that provides the precise reason for the denial by the card network or anti-fraud solution.",
"type": "string",
"examples": [
"FM",
"57",
"05",
"A1"
]
},
"evaluation_order": {
"title": "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.",
"type": "integer",
"minimum": 1,
"maximum": 99,
"examples": [
99
]
}
}
},
"origin": {
"title": "The request origin of address register operation",
"type": "string",
"minLength": 1,
"maxLength": 3,
"examples": [
"P2P",
"PAYMENTS"
]
},
"roles": {
"title": "The roles of operator that registered address",
"type": "array",
"items": {
"type": "string"
},
"examples": [
"test1",
"test2"
]
},
"uri": {
"title": "The URI of address register operation",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"/v1/accounts/{accountId}/spending-limits/{spendingLimitId}"
]
}
}
}
Updated 16 days ago