Queue uploaded payment-control imports for processing

Enterprise+ tier

POSThttps://lens-api.tic.io/payment-controls/imports/process

Each import still in Submitted status is queued. Imports already past Submitted are skipped.

The status on completion is delivered in one of two ways:

SignalR (the Lens UI): supply correlationId. The status is broadcast to the caller as the LensPaymentControlImportStatus event.
Webhook (API integrations): supply webhookUrl (HTTPS recommended) and optionally webhookSecret. A signed JSON envelope (PaymentControlImportStatus_Request shape) is POSTed to your URL on terminal status. Verify X-TIC-Signature: HMAC-SHA256 of the body with your secret.

When both are supplied, webhookUrl wins and no SignalR broadcast is sent for that import.

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Bodyapplication/json

importGuidsstring[] | null

correlationIdstring | null

webhookUrlstring | null

webhookSecretstring | null

Responses

Processed/skipped counts and any per-import errors · application/json

processedCountinteger

format: int32

skippedCountinteger

format: int32

errorsstring[] | null

Authorization

Stored in this browser only (until you forget it) and sent as the x-api-key header through the documentation proxy.

Body application/json

Enter your API key to send.

Request

curl -X POST "https://lens-api.tic.io/payment-controls/imports/process" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "importGuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "correlationId": "<string>",
  "webhookUrl": "<string>",
  "webhookSecret": "<string>"
}'

{
  "processedCount": 123,
  "skippedCount": 123,
  "errors": [
    "<string>"
  ]
}