Skip to main content
GET
/
settlements
/
{id}
Settlement detail (with lines)
curl --request GET \
  --url https://api.safarapi.com/api/partner/v1/settlements/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.safarapi.com/api/partner/v1/settlements/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.safarapi.com/api/partner/v1/settlements/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.safarapi.com/api/partner/v1/settlements/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.safarapi.com/api/partner/v1/settlements/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.safarapi.com/api/partner/v1/settlements/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.safarapi.com/api/partner/v1/settlements/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{ "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" } ] }

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
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[]