Skip to main content
POST
/
v3
/
{customerId}
/
attributes
/
upload
Upload (Base Example)
curl --request POST \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/attributes/upload \
  --header 'Content-Type: application/json' \
  --data '
{
  "Origin Country": "us"
}
'
{
  "HttpStatusCode": 0,
  "Card": {
    "sum_debits_30_days": 0,
    "AttributesDetail": [
      {
        "Attribute": "<string>",
        "Transactions": [
          {
            "TransactionId": "<string>",
            "AccountId": "<string>",
            "Date": "<string>",
            "Description": "<string>",
            "Debit": 0,
            "Credit": 123,
            "Balance": 0
          }
        ]
      }
    ]
  },
  "requestId": "<string>"
}
Please select your required endpoint based on information you read in the previous section. All endpoints follow the same format, and all demand a POST call to their respective URLs with a JSON body request. For this documentation, we will use the standard /Upload endpoint to run through some examples. If you are using any of the other endpoints listed above, the only difference is that you do not need to include an Attributes or AttributesDetail list.

A note on Authorization

In order to access and use any of the /Upload endpoints, you will need a secret authorization token from Flinks. If you do not already have one, please reach out to your Flinks Representative.

A note on Use Case and All Attributes endpoints

The Card and AttributesDetails objects within these requests are not required and, if provided, will be overwritten with the expected Attributes contained within the requested endpoint.

​
Request Fields

NAMEDESCRIPTIONRequired?
CardContains the list of Attributes that will be returned for the given set of transactions.Yes
Origin CountryTells the API to use a specific country model. The only accepted values are ‘ca’ or ‘us’.Yes
MostRecentBalanceTells the API what the MostRecentBalance was for these transactions. This is an alternative to attaching a balance to every transaction. If provided, Flinks will calculate the running balance per transaction using the provided figure. Please provide us the balance as of the most recent transaction here. If using this option, do not include the balance field in your transaction set or use OldestBalance.Yes (if not using balance per transaction or OldestBalance)
OldestBalanceTells the API what the Oldest Balance was for those transactions. This is an alternative to attaching a balance to every transaction. If provided, Flinks will calculate the running balance per transaction using the provided figure. Please provide us the balance as of the oldest (historic) transaction here. If using this option, do not include the balance field in your transaction field or use MostRecentBalance.Yes (If not using balance per transaction or MostRecentBalance)
AttributesDetailThis will return an object in the response that contains the relevant transactions for all Attributes that are contained here. Please refer to our Attributes documentation for more information.No
TransactionsContains the previously formatted transactions (defined earlier in this documentation) that you are uploading to Flinks.Yes

Headers

​
Authorization
string

Bearer Token (API secret key).

Path Parameters

​
customerId
string
required

Unique GUID provided by Flinks that grants you access to the environment.

Body

application/json
​
Origin Country
enum<string>
required

Tells the API to use a specific country model. Possible values include: - ca = Canada - us = United States

Available options:
ca,
us
​
Card
string

Contains the list of Attributes that will be returned for the given set of transactions. (JSON object)

​
MostRecentBalance
string

The most recent balance for all transactions. Flinks uses this parameter to calculate the running balance if you are not passing the balance field in your transaction set or using OldestBalance.

If you are not using balance in the transaction set or OldestBalance, this parameter is required.

​
OldestBalance
string

The oldest balance of all transactions. Flinks uses this parameter to calculate the running balance if you are not passing the balance field in your transaction set or using MostRecentBalance.

If you are not using balance in the transaction set or MostRecentBalance, this parameter is required.

​
AttributesDetail
string[]

List of Attributes that you require the underlying transactions to be returned from. Attribute names included here must also be included in the Attributes list.

​
Transactions
string

Contains the previously formatted transactions (defined earlier in this documentation) that you are uploading to Flinks. (JSON array of objects)

​
Options
string[]

Additional parameters that you want to include.

Response

Result

​
HttpStatusCode
integer
default:0
​
Card
object
​
requestId
string