Generate receipt upload URL

POST

https://api.light.inc/v1/card-transactions/{cardTransactionId}/receipt-upload-url

Generates a secure upload URL for receipt documents

Note

The URL is valid for five minutes; PUT the bytes with the declared Content-Type and every entry of metadata as a request header, or the upload is rejected (see Files). There is no follow-up call: Light picks the file up, converts it to PDF and sets receiptDocumentKey asynchronously — to the key of the converted PDF, not the key returned here — so poll GET /v1/card-transactions/{id} until it is non-null. If conversion fails, failureContext is set with CARD_TRANSACTION_PDF_RECEIPT_FAILED.

While the transaction is unposted the receipt is also read by Light's document AI, which writes the account, tax code and custom properties it extracts onto every line — coding you set before the upload can be overwritten. The cardTransactionId is not checked at this step; a wrong id only fails later, inside the background job. Requires a user credential, not an API key.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

API key
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Bearer token

Path parameters

cardTransactionId string · uuidrequired

Request body

application/json;charset=UTF-8

filename string
contentType string

Response

uploadUrl string · url
key string
metadata object

cURL

curl -X POST "https://api.light.inc/v1/card-transactions/3c90c3cc-0d44-4b50-8888-8dd25736052a/receipt-upload-url" \
  -H "Authorization: Basic YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "filename": "string",
  "contentType": "string"
}'

JavaScript

const res = await fetch("https://api.light.inc/v1/card-transactions/3c90c3cc-0d44-4b50-8888-8dd25736052a/receipt-upload-url", {
  method: "POST",
  headers: {
    Authorization: `Basic ${process.env.LIGHT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "filename": "string",
    "contentType": "string"
  }),
});
const data = await res.json();

Python

import os, requests

res = requests.post(
    "https://api.light.inc/v1/card-transactions/3c90c3cc-0d44-4b50-8888-8dd25736052a/receipt-upload-url",
    headers={
        "Authorization": f"Basic {os.environ['LIGHT_API_KEY']}",
    },
    json={
        "filename": "string",
        "contentType": "string"
    },
)
data = res.json()

Example requestGenerated

{
  "filename": "string",
  "contentType": "string"
}

Generated from the schema: shapes and types are real, values are placeholders, and fields that exclude each other are all shown. Do not send it unchanged.

Example responseGenerated

{
  "uploadUrl": "https://example.com",
  "key": "string",
  "metadata": null
}

Generated from the schema: shapes and types are real, values are placeholders.