Settlement detail (with lines)
One settlement with its per-line breakdown (bookings, refunds, adjustments). net_due = bookings_total − refunds_total + adjustments_total.
Authorizations
API key authentication. Issued by the Safariat admin or via the partner portal. The secret is shown only once at generation.
Production sk_live_* keys must additionally sign every write request
(POST/PUT/DELETE) with the X-Timestamp and X-Signature headers.
Sandbox sk_test_* keys are exempt from request signing: X-Signature and
X-Timestamp are not required for writes in the sandbox (so the developer-portal
"Try it" playground works end to end). The Idempotency-Key header remains
required on writes in both environments.
Path Parameters
Settlement UUID. List GET /settlements first and use a returned id; sandbox settlements are issued by the monthly job, not pre-seeded.
Response
Detailed settlement
DRAFT: generated, under Safariat admin review, not visible to the bank.ISSUED: issued, PDF invoice available, payment expected.PAID: transfer received, marked by a Safariat admin.OVERDUE: past the due date without payment.DISPUTED: the bank disputes it, blocking future issuances.CANCELLED: administrative cancellation (exception).
DRAFT, ISSUED, PAID, OVERDUE, DISPUTED, CANCELLED bookings_total − refunds_total + adjustments_total
MAD "INV-PRT-2026-000042"
Pre-signed URL to the PDF (null if DRAFT).