> ## Documentation Index > Fetch the complete documentation index at: https://developers.safarapi.com/llms.txt > Use this file to discover all available pages before exploring further. # Settlement detail (with lines) > One settlement with its per-line breakdown (bookings, refunds, adjustments). `net_due = bookings_total − refunds_total + adjustments_total`. ## OpenAPI ````yaml /api-reference/openapi.yaml get /settlements/{id} openapi: 3.1.0 info: title: SafarAPI version: 1.0.0 summary: B2B API for banking partners — Safariat catalog and booking description: > SafarAPI lets banking partners integrate the Safariat travel catalog into their authenticated customer areas and book on behalf of their own end customers who are already authenticated and KYC-verified on the bank side. ## Channel model - The traveler never authenticates with Safariat. - Payment is collected on the banking platform (out-of-band from Safariat). - The bank submits the HMAC-signed payment confirmation at booking time. - Monthly post-payment settlement (see `GET /settlements`). ## Authentication Bearer API key in the `Authorization` header. Format `sk_live__` (production) or `sk_test__` (sandbox). The secret is shown only once at key generation — Safariat stores only an argon2id hash. ## Write request signing Production write requests (`POST`, `PUT`, `DELETE`) additionally require: - `X-Timestamp`: Unix timestamp in seconds, validity window ±5 minutes. - `X-Signature`: `hex(HMAC_SHA256(secret, "{timestamp}\n{method}\n{path}\n{body}"))`. - `Idempotency-Key`: opaque string unique per operation (UUID v4 recommended), retained for 24 h. Replayed responses carry an `Idempotent-Replayed: true` header. Request signing applies only to production `sk_live_*` keys. 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). `Idempotency-Key` is still required on writes in both environments. ## Error format All errors follow the `Error` schema with a stable i18n code, an English message, and the `request_id` for correlation with Safariat logs. ## Versioning URL-based versioning (`/v1`). No breaking changes within a version. Removals are announced 6 months in advance via the `Sunset` header (RFC 8594). ## Rate limiting Default limit of 600 req/min per key, contractually adjustable. The `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers are returned on every response. Exceeding the limit → `429 Too Many Requests` plus the `Retry-After` header. ## Sandbox An `sk_test_*` key targets the same infrastructure as production but isolates bookings in `test_mode=true`: no real email is sent, no settlement is issued, and webhooks are marked `test: true`. contact: name: SafarAPI Team email: api@safariat.ma url: https://developers.safariat.ma license: name: Proprietary — use subject to a signed partner agreement termsOfService: https://safariat.ma/legal/partner-terms servers: - url: https://api.safarapi.com/api/partner/v1 description: >- Production and sandbox share this host. The environment is selected by the API key prefix: sk_live_ targets production, sk_test_ targets the sandbox. security: - apiKey: [] tags: - name: Meta description: Metadata for the current key, service health. - name: Catalog description: Browsing the Safariat adventure catalog. - name: Quotes description: Price-locked quotes (30 min TTL) ahead of booking. - name: Bookings description: Creating, retrieving, and cancelling bookings. - name: Settlements description: Monthly Safariat → partner payout invoices. - name: Webhooks description: Managing endpoints that receive Safariat events. - name: Team description: Members of the partner console workspace and their roles. - name: Reviews description: Read-only access to traveler reviews on the Safariat catalog. - name: Files description: Presigned uploads for partner-supplied files (currently review photos). paths: /settlements/{id}: get: tags: - Settlements summary: Settlement detail (with lines) description: >- One settlement with its per-line breakdown (bookings, refunds, adjustments). `net_due = bookings_total − refunds_total + adjustments_total`. operationId: getSettlement parameters: - $ref: '#/components/parameters/SettlementId' responses: '200': description: Detailed settlement content: application/json: schema: $ref: '#/components/schemas/SettlementDetail' example: id: 0a9f8e7d-6c5b-4a3f-8e2d-1c0b9a8f7e6d invoice_number: INV-PRT-2026-000042 period_start: '2026-07-01' period_end: '2026-07-31' status: ISSUED bookings_count: 1 refunds_count: 0 bookings_total: amount: '5400.00' currency: MAD refunds_total: amount: '0.00' currency: MAD adjustments_total: amount: '0.00' currency: MAD net_due: amount: '5400.00' currency: MAD currency: MAD issued_at: '2026-08-01T06:00:00Z' due_at: '2026-08-31' paid_at: null invoice_pdf_url: https://placehold.co/600x400?text=DEMO lines: - booking_number: MV-AB7X92 line_type: BOOKING amount: amount: '5400.00' currency: MAD occurred_at: '2026-07-12T10:05:00Z' description: >- [DEMO] 3-day Sahara desert circuit from Marrakech — Comfort '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: SettlementId: in: path name: id required: true schema: type: string format: uuid example: 0a9f8e7d-6c5b-4a3f-8e2d-1c0b9a8f7e6d description: >- Settlement UUID. List `GET /settlements` first and use a returned id; sandbox settlements are issued by the monthly job, not pre-seeded. schemas: SettlementDetail: allOf: - $ref: '#/components/schemas/Settlement' - type: object properties: lines: type: array items: $ref: '#/components/schemas/SettlementLine' Settlement: type: object required: - id - period_start - period_end - status - net_due - currency properties: id: type: string format: uuid invoice_number: type: string nullable: true example: INV-PRT-2026-000042 period_start: type: string format: date period_end: type: string format: date status: $ref: '#/components/schemas/SettlementStatus' bookings_count: type: integer refunds_count: type: integer bookings_total: $ref: '#/components/schemas/Money' refunds_total: $ref: '#/components/schemas/Money' adjustments_total: $ref: '#/components/schemas/Money' net_due: $ref: '#/components/schemas/Money' description: bookings_total − refunds_total + adjustments_total currency: type: string enum: - MAD issued_at: type: string format: date-time nullable: true due_at: type: string format: date nullable: true paid_at: type: string format: date-time nullable: true invoice_pdf_url: type: string format: uri nullable: true description: Pre-signed URL to the PDF (null if DRAFT). SettlementLine: type: object required: - booking_number - line_type - amount - occurred_at properties: booking_number: type: string line_type: type: string enum: - BOOKING - REFUND - ADJUSTMENT amount: $ref: '#/components/schemas/Money' description: >- Positive for BOOKING / ADJUSTMENT+, negative for REFUND / ADJUSTMENT−. occurred_at: type: string format: date-time description: type: string nullable: true Error: type: object required: - code - message - request_id properties: code: type: string description: | Stable, documented i18n code. Form `domain.subdomain.detail` (e.g. `payment.amount.mismatch`, `auth.api_key.invalid`). example: validation.required.field message: type: string description: >- English message (for bank logs). API errors are never localized on the Safariat side. example: Field 'rate_pack_id' is required. request_id: type: string description: Unique request ID on the Safariat side. details: type: object description: Optional structured details (offending field, expected value, etc.). additionalProperties: true SettlementStatus: type: string enum: - DRAFT - ISSUED - PAID - OVERDUE - DISPUTED - CANCELLED description: > - `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). Money: type: object required: - amount - currency properties: amount: type: string pattern: ^-?\d+\.\d{2}$ description: Amount as a decimal string with 2 decimals to preserve precision. example: '3200.00' currency: type: string enum: - MAD description: Currency — MAD only in V1. example: MAD responses: Unauthorized: description: API key missing, invalid, expired, or incorrect HMAC signature. content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing: value: code: auth.api_key.missing message: Authorization header is required. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC invalid: value: code: auth.api_key.invalid message: The provided API key is invalid or has been revoked. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC signatureInvalid: value: code: auth.signature.invalid message: HMAC signature does not match. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC timestampSkew: value: code: auth.timestamp.skew message: Timestamp is more than 5 minutes off server time. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC NotFound: description: Resource does not exist or is inaccessible for this partner. content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Rate limit exceeded for the current key. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/Error' example: code: rate_limit.exceeded message: Rate limit exceeded for this API key. request_id: 01HXY2ZRPM3R8K9PSBTRQYNFHC headers: RetryAfter: schema: type: integer description: Seconds to wait before the next attempt (RFC 7231). XRateLimitLimit: schema: type: integer description: Request limit per minute for the current key. XRateLimitRemaining: schema: type: integer description: Requests remaining in the current window. XRateLimitReset: schema: type: integer format: int64 description: Unix timestamp (s) at which the window resets. securitySchemes: apiKey: type: http scheme: bearer bearerFormat: sk_live__ or sk_test__ x-default: sk_test_DEMO0000_replace_with_your_sandbox_key description: > 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. ````