Skip to main content
POST
Queue uploaded payment-control imports for processing
Enterprise+ tier 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:
  1. SignalR (the Lens UI): supply correlationId. The status is broadcast to the caller as the LensPaymentControlImportStatus event.
  2. 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.

Authorizations

x-api-key
string
header
required

Body

importGuids
null | string<uuid>[]
correlationId
null | string
webhookUrl
null | string
webhookSecret
null | string

Response

Processed/skipped counts and any per-import errors

processedCount
integer<int32>
skippedCount
integer<int32>
errors
null | string[]