Deprecated API Reference
This API Reference is being deprecated. Please use the New API Reference.
List all external links
List all the previously created External Links. For more info, see Uploading files to Finix.
curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links \
-H 'Content-Type: application/vnd.api+json' \
-H 'Finix-Version:2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X GET
Example response
{
"_embedded": {
"external_links": [
{
"id": "EL_a4qV42tDFHusrPD9H44bwu",
"created_at": "2022-02-28T10:14:36.353919-08:00",
"url": "https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/external_link_id_1",
"type": "DOWNLOAD",
"expires_at": "2022-02-28T10:24:36.347676-08:00",
"user_id": "USsRhsHYZGBPnQw8CByJyEQW",
"file_id": "FILE_bJecqoRPasStEPVpvKHtgA",
"duration": null,
"tags": {
"key": "value"
},
"expired": true
},
{
"id": "EL_9gfWgST6hYSx4zqJ5n1C5u",
"created_at": "2022-02-28T10:14:25.538041-08:00",
"url": "https://finix.sandbox-payments-api.com/files/FILE_bJpuitRPasStEPVpvKHlkE/external_links/external_link_id_2",
"type": "UPLOAD",
"expires_at": "2022-02-28T10:24:25.465268-08:00",
"user_id": "USiCkWDhvB5nwEPgzVi2G5yH",
"file_id": "FILE_bJpuitRPasStEPVpvKHlkE",
"duration": null,
"tags": {
"key": "value"
},
"expired": true
}
],
}
}
HTTP Request
GET https://finix.sandbox-payments-api.com/files/:FILE_ID:/external_links/external_link_id
URL Parameters
Parameter |
Description |
---|---|
:FILE_ID: | The File ID that was created first to upload the file |
Response
Field | Type | Description |
---|---|---|
id |
string | The ID of the External Link resource. |
created_at |
string | Timestamp of when the File ID was created. |
url |
string | The link you can share with merchants to UPLOAD or DOWNLOAD files depending on the type . |
type |
string | Sets if the link is for uploading or downloading files from Finix. |
expires_at |
string | The timestamp that the external link expires at. |
user_id |
string | The user id that requested to create this link. |
file_id |
string | The File ID the External Link is related to. |
duration |
string | If configured, how long the link is active for (in minutes). |
tags |
object | A custom value you can include to annotate the file object's metadata. (e.g. file number) |
expired |
boolean |
|