Payments

Payments drivers collected in the field: online through Mollie, at the vehicle’s terminal, or cash. Taking a payment stays with the driver app. Through the API you read payments and review them before they’re invoiced.

Amounts use Mollie’s shape: { "value": "45.00", "currency": "EUR" }, with the value as a string.

List payments

GET/v1/payments

Requires the scope payments:read.

Available from phase 2

Payments drivers collected for rides: online, at the vehicle's terminal, or cash.

Query parameters

statusstring

pending, paid, authorized, failed, canceled or expired.

review_statusstring

pending, approved or rejected.

created_afterISO 8601

Only records created after this time.

created_beforeISO 8601

Only records created before this time.

updated_afterISO 8601

Only records changed after this time. For a sync, pass your last sync time minus 60 seconds and deduplicate by id.

limitinteger

Page size, 1 to 100. Default 25.

cursorstring

The next_cursor of the previous page.

Request

curl "https://api.ambula.nl/v1/payments?status=paid&review_status=pending" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "data": [
    {
      "id": "p_5Kd3",
      "ride_id": "r_7Hq2xV",
      "status": "paid",
      "method": "ideal",
      "amount": {
        "value": "45.00",
        "currency": "EUR"
      },
      "services": [
        {
          "code": "OPH",
          "name": "Ophalen dier",
          "price": {
            "value": "45.00",
            "currency": "EUR"
          },
          "vat_rate": "21"
        }
      ],
      "review_status": "pending",
      "paid_at": "2026-11-09T09:01:12Z",
      "created_at": "2026-11-09T08:58:40Z",
      "updated_at": "2026-11-09T09:01:12Z"
    }
  ],
  "next_cursor": null
}

Get a payment

GET/v1/payments/{id}

Requires the scope payments:read.

Available from phase 2

One payment.

Request

curl "https://api.ambula.nl/v1/payments/p_5Kd3" \
  -H "Authorization: Bearer amb_live_<key>"

Response · 200

{
  "id": "p_5Kd3",
  "ride_id": "r_7Hq2xV",
  "status": "paid",
  "method": "ideal",
  "amount": {
    "value": "45.00",
    "currency": "EUR"
  },
  "services": [
    {
      "code": "OPH",
      "name": "Ophalen dier",
      "price": {
        "value": "45.00",
        "currency": "EUR"
      },
      "vat_rate": "21"
    }
  ],
  "review_status": "pending",
  "paid_at": "2026-11-09T09:01:12Z",
  "created_at": "2026-11-09T08:58:40Z",
  "updated_at": "2026-11-09T09:01:12Z"
}

Review a payment

PATCH/v1/payments/{id}

Requires the scope payments:write.

Available from phase 2

Set the review status of a paid payment before it is invoiced. Only review_status can change.

Body

review_statusstringrequired

approved or rejected.

Request

curl -X PATCH "https://api.ambula.nl/v1/payments/p_5Kd3" \
  -H "Authorization: Bearer amb_live_<key>" \
  -H "Content-Type: application/json" \
  -d '{"review_status":"approved"}'

Response · 200

{
  "id": "p_5Kd3",
  "ride_id": "r_7Hq2xV",
  "status": "paid",
  "method": "ideal",
  "amount": {
    "value": "45.00",
    "currency": "EUR"
  },
  "services": [
    {
      "code": "OPH",
      "name": "Ophalen dier",
      "price": {
        "value": "45.00",
        "currency": "EUR"
      },
      "vat_rate": "21"
    }
  ],
  "review_status": "approved",
  "paid_at": "2026-11-09T09:01:12Z",
  "created_at": "2026-11-09T08:58:40Z",
  "updated_at": "2026-11-09T09:01:12Z"
}

Invoice in Asperion

POST/v1/payments/{id}/sync-to-asperion

Requires the scope payments:write.

Available from phase 4

Book an approved payment in Asperion, the company's accounting system. Requires a connected Asperion administration.

Side effect. Creates an invoice in Asperion.

Request

curl -X POST "https://api.ambula.nl/v1/payments/p_5Kd3/sync-to-asperion" \
  -H "Authorization: Bearer amb_live_<key>" \
  -H "Idempotency-Key: 4f1c9a2e-…"

Response · 200

{
  "id": "p_5Kd3",
  "asperion_invoice_number": "2026-0412",
  "synced_at": "2026-11-09T12:10:00Z"
}