Transaction Limits Utilization Object

The Transaction Limits Utilization object represents the actual transaction amounts used for each transaction limit in a Customer Account, Customer Financial Account, or Business Financial Account.

Note Transaction limits apply to internal and integrated bank Financial Accounts only.

Attributes

string (UUID)

ID of the transaction limit.

limitType

string enum, values: SINGLE, DAILY, WEEKLY, MONTHLY

Type of transaction limit. The following values are supported:

SINGLE Maximum amount allowed for a single transaction.
DAILY Maximum cumulative amount allowed for a single day (00:00 – 23:59:59:59 EST).
WEEKLY Maximum cumulative amount allowed for a rolling 7-day period.
MONTHLY Maximum cumulative amount allowed for a rolling 30-day period.

scopeId

string (UUID)

ID of the Customer Account or Financial Account to which the transaction limit belongs.

scopeType

string enum, values: CUSTOMER, FA_KFA

Type of entity referenced in scopeId. The following values are supported:

CUSTOMER Customer Account.
FA_KFA Financial Account.

currency

string, min length: 3, max length: 3

Currency used for the transaction limit. Must be an ISO 4217 alpha 3-character currency code.

limitAmount

number

Amount of the transaction limit.

deductionAmount

number

Amount of the transaction limit that has been used.

fromRange

string (date-time)

Start date for the transaction limits utilization period.

toRange

string (date-time)

End date for the transaction limits utilization period.

Transaction Limits Utilization Object

				
					{
  "id": "string(UUID)",
  "limitType": "SINGLE | DAILY | WEEKLY | MONTHLY",
  "scopeId": "string(UUID)",
  "scopeType": "CUSTOMER |  FA_KFA",
  "currency": "string",
  "limitAmount": number,
  "deductionAmount": number,
  "fromRange": "string(date-time)",
  "toRange": "string(date-time)"
}