Use the /Attributes endpoint to tell us the data points in your attributes package you want to retrieve.
Request Parameters
| Name | Type | Description |
|---|---|---|
| customerId (mandatory) | string | GUID representing your customer ID (provided by Flinks) |
| loginId (mandatory) | string | GUID representing end user's login ID. You get this value after a successful Authorize request. |
| requestId (mandatory) | string | GUID representing an authorized request to the API. You get this value after a successful Authorize request. |
| Attributes (mandatory) | object | Lists of desired Attributes broken-down by Attribute level (card is currently the only supported attribute level). |
| Filters (optional) | object | Filters 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) | object | Filters 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) | object | Acts 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) | object | Optional 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
AccountFiltercan only be used in conjunction withFilter. 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
Attributesparameter above.
Response Fields
| Name | Type | Description |
|---|---|---|
| Card | object | Object containing a id field (end user's LoginId) and all the requested attributes (name: value) |
| Login | object | Object representing some end user's technical information such as the LoginId. See Authorize endpoint documentation for this object details. |
| RequestId | string | GUID representing an authorized request to the API. You get this value after a successful Authorize request. |
| AttributeDetails (Optional) | object | Object containing the fields TransactionId, AccountId, Date, Description, Debit, Credit per Attribute. |
Note on Custom Attributes
If you are utilizing the
Attributes Builderfeature to create custom Attributes within the Client Dashboard, then you are able to include your createdAttribute Namesunder thecardobject alongside any other pre-created Attributes.