Request Parameters

NameTypeDescription
customerId
(mandatory)
stringGUID representing your customer ID (provided by Flinks)
loginId
(mandatory)
stringGUID representing end user's login ID. You get this value after a successful Authorize request.
requestId
(mandatory)
stringGUID representing an authorized request to the API. You get this value after a successful Authorize request.
Attributes
(mandatory)
objectLists of desired Attributes broken-down by Attribute level (card is currently the only supported attribute level).
Filters
(optional)
objectFilters to apply to transactions for which attributes will be calculated.

Supported values:
- accountCategory: List of account categories (Operations is currently the only supported value).
AccountFilter
(optional)
objectFilters to apply to transactions for which attributes will be calculated, differs from the general Filter parameter above, as this targets specific accounts.

Supported values:
- AccountID: List of accountID's to be used in the Attributes calculation (AccountID is taken from the GetAccountsDetail response). Multiple accountID's can be used.
AttributesDetail
(optional)
objectActs the same as the Attributes parameter, but can be used to return underlying transactions from the Attributes calculation. Include lists of desired Attributes (must also be present at the card level above).

Supported values:
- AttributesDetail: List of Attributes that underlying transactions need to be returned from.
limitDays
(optional)
objectOptional Parameter to include in the header of any Attributes request that will limit the amount of days of transactions used to calculate all Attributes to the days option passed in this parameter. Supports between 1 and 365 days.

Supported values:
- limitDays: Any integer value from 1-365 that defines the amount of days of transactions used in the Attributes calculation (Supported on any GET or POST request to Attributes).

🚧

Note on 'Filters' and 'AccountFilter'

The parameter AccountFilter can only be used in conjunction with Filter . You must have both present if you need to filter by specific accounts.

🚧

Note on 'AttributesDetail'

Only Attributes that are 'Sum' or 'Count' are allowed here. 'Average' or other types of Attributes are not supported here. Any Attribute name that is included here must also be included in the mandatory Attributes parameter above.

Response Fields

NameTypeDescription
CardobjectObject containing a id field (end user's LoginId) and all the requested attributes (name: value)
LoginobjectObject representing some end user's technical information such as the LoginId. See Authorize endpoint documentation for this object details.
RequestIdstringGUID representing an authorized request to the API. You get this value after a successful Authorize request.
AttributeDetails (Optional)objectObject containing the fields TransactionId, AccountId, Date, Description, Debit, Credit per Attribute.
Language
URL