Skip to main content
GET
Settlement detail (with lines)

Authorizations

Authorization
string
header
default:sk_test_DEMO0000_replace_with_your_sandbox_key
required

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

id
string<uuid>
required

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

id
string<uuid>
required
period_start
string<date>
required
period_end
string<date>
required
status
enum<string>
required
  • 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).
Available options:
DRAFT,
ISSUED,
PAID,
OVERDUE,
DISPUTED,
CANCELLED
net_due
object
required

bookings_total − refunds_total + adjustments_total

currency
enum<string>
required
Available options:
MAD
invoice_number
string | null

INV-PRT-- in live, INV-PRT-TEST-- in sandbox.

Example:

"INV-PRT-2026-000042"

bookings_count
integer
refunds_count
integer
bookings_total
object
refunds_total
object
adjustments_total
object
issued_at
string<date-time> | null
due_at
string<date> | null
paid_at
string<date-time> | null
invoice_pdf_url
string<uri> | null

Pre-signed URL to the PDF (null if DRAFT).

lines
object[]