List Transaction Limit Utilization for an Account

Retrieve a list of the actual transaction amounts used for each transaction limit in a Customer Account, Customer Financial Account, or Business Financial Account.

Transaction limits define the maximum debit transaction amounts for an account, and include single, daily, weekly, and monthly limits.

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

Endpoint

GET /v1/limits/utilisation

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

scopeId REQUIRED

string (UUID)

ID of the Customer Account or Financial Account.

scopeType REQUIRED

string enum, values: CUSTOMER, FA_KFA

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

CUSTOMER Customer Account.
FA_KFA Financial Account.

referenceDate

string (date)

End date used to retrieve limit utilization results. The query will return results up to and including this date.

Request Body

None

Returns

Returns an array of Transaction Limits Utilization objects. This object contains details for each limit, including the actual amount used for the limit during the specified date range.

SAMPLE RESPONSE

				
					[
  {
    "limitId": "861446e4-437e-4f10-9b5c-fda856d125c5",
    "limitType": "SINGLE",
    "scopeId": "d6e3efb0-dcd3-4211-b1aa-6353a92fbc8a",
    "scopeType": "FA_KFA",
    "currency": "USD",
    "limitAmount": 250.00,
    "deductionAmount": 200.00,
    "fromRange": "2024-02-01T01:46:44.793Z",
    "toRange": "2024-02-27T01:46:44.793Z"
  },
  {...},
  {...}
]