Deprecated API Reference
This API Reference is being deprecated. Please use the New API Reference.
Fetch an External Link
Fetch a previously created external_link
resource. For more info see Uploading files to Finix.
curl https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/external_links/ \
-H 'Finix-Version:2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X GET
Example response
{
"id" : "EL_sVv61JP93htzDFTtNhbsdd",
"created_at" : "2022-05-24T06:50:51.94704Z",
"url" : "http://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/.../:FILE_TYPE:/FILE_bJecqoRPasStEPVpvKHtgA/...",
"type" : "UPLOAD",
"expires_at" : "2022-05-24T07:05:51.934426Z",
"user_id" : "USsRhsHYZGBPnQw8CByJyEQW",
"file_id" : "FILE_bJecqoRPasStEPVpvKHtgA",
"duration" : null,
"tags" : { },
"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 has the links you want to retrieve. |
Response
Field | Type | Description |
---|---|---|
id |
string | The ID of the External Link. |
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 |
|