Please select your required endpoint to be called based on 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.
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 [email protected]
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
| Name | Description | Required |
|---|---|---|
| Card | Contains the list of Attributes that will be returned for the given set of transactions. | Yes (Not required if using /GetAllAttributes or a use case endpoint) |
| Origin Country | Tells the API to use a specific country model. Only accepted values are: - “ca” - “us” | Yes |
| MostRecentBalance | Tells the API what the MostRecentBalance 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 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) |
| OldestBalance | Tells 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 the balance as of the oldest (historic) transaction here. If using this option, do not include the balance field in your transaction set or use MostRecentBalance. | Yes (if not using balance per transaction or OldestBalance) |
| AttributesDetail | This will return an object in the response that contains relevant transactions for all Attributes that are contained here. Please refer to our Attributes documentation for more information. | No |
| Transactions | Contains the previously formatted transactions (defined earlier in this documentation) that you are uploading to Flinks. | Yes |