Requests and users
Link receipts to your IDs and find saved checks.
Send your own IDs
Add these fields to a receipt check request:
| Field | Purpose | Format |
|---|---|---|
external_id | Find checks for your request | Optional string, 1–128 characters |
external_user_id | Find your user’s history | Optional string, 1–200 characters |
For example: external_id=payment-123, external_user_id=customer:00042.
Values retain their case and leading zeros. IDs belong to your company and are
not linked to other companies’ data.
A request can have several checks. external_id does not prevent duplicate
submissions — use Idempotency-Key for that.
Omit external_user_id when you do not know the user ID.
Find checks for a request
curl --get 'https://api.kvitera.tech/v1/checks' \
-H "Authorization: Bearer $KVITERA_API_KEY" \
--data-urlencode 'external_id=payment-123' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=20'The response contains items (check summaries), total (the total result count),
and page, limit and pages. Newer checks appear first by default.
Use an ID from the list to retrieve the full result:
GET /v1/checks/{id}.
Find a user’s history
Replace the filter with external_user_id=customer:00042 in the same request.
Send both fields to find checks for a particular request belonging to that user.
Both ID filters use exact matching. Provide at least one or the API returns 422.
The list may include checks with status: processing; wait for them to finish.
Searching and retrieving results do not use your check allowance.