Bookings

Prepay booking

Marks targeted orders as Prepaid: the passenger paid prepaid in advance and pays the rest on boarding. Authenticated via the api-key header; data scoped to the caller's partner. The same amount applies to every targeted ticket, in each ticket's own currency; to record different amounts, call once per subset of tickets. Hold, Booked and Prepaid orders can be prepaid; prepaying a Prepaid order replaces its amount. 400 when the amount is not less than a targeted ticket's price, or when a targeted ticket is not a PrexSell offer. 409 Conflict when any targeted order is Paid, Canceled, or Refund. All targeted orders are written together or none is. paymentRecipient is always Agent. As with Book booking, the carriers are notified when an order first becomes Prepaid (the passenger is not — tell your passenger yourself); changing the amount notifies no one. Prepaid orders do NOT fiscalize. Returns the refreshed booking after the write.

POSThttps://api.prexsell.com/v2/bookings/{id}/prepay

Authorizations

  • x-api-keystring · headerrequired

    Partner API key, sent in the x-api-key request header. Required for bookable offer search and all booking operations. To obtain a key, register as a PREXSELL partner in the backoffice (backoffice.prexsell.com, or staging.backoffice.prexsell.com for staging) and contact support if you need help.

Path Parameters

  • idstringrequired

    Booking identifier.

    Example: bkg_1

Body

application/json

Prepay booking request body.

  • prepaidnumberrequired

    Amount the passenger paid in advance, in the booking's currency. Greater than 0 and less than the price of every targeted ticket.

  • ticketIdsstring[]

    Optional subset of ticket IDs to act on. Must be a subset of the booking's current actor-owned tickets — any unknown or foreign ID returns 404 (not 403). Defaults to ALL current partner-owned tickets in the booking. Takes precedence over the deprecated orderIds alias when both are supplied.

    Minimum array length: 1

    Ticket (order) identifier.

  • orderIdsstring[]deprecated

    DEPRECATED — use ticketIds. Optional subset of order IDs to act on. Must be a subset of the booking's current actor-owned orders — any unknown or foreign ID returns 404 (not 403). Defaults to ALL current partner-owned orders in the booking (current-state, not creation-snapshot — a booking's members change on peel-off).

    Minimum array length: 1

    Order identifier.

Response 200

application/json

Booking action result (post-write refresh).

  • dataobjectrequired

    Action result (refreshed booking state).

Response 400

application/json

Standard error response body.

  • errorsobject[]required

    Array of error objects. Shape depends on origin: CustomError paths emit { message, errorCode } items; request-validation paths emit { message, field, ...constraint params } items, where field is the offending request field (e.g. "departureDate").

Response 401

application/json

Standard error response body.

  • errorsobject[]required

Response 404

application/json

Standard error response body.

  • errorsobject[]required

Response 409

application/json

Standard error response body.

  • errorsobject[]required

Prepay booking

curl --request POST \
  --url 'https://api.prexsell.com/v2/bookings/{id}/prepay' \
  --header 'x-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "prepaid": 300,
  "ticketIds": [
    "ord_abc"
  ]
}'

To test first, swap https://api.prexsell.com for https://staging.api.prexsell.com.

{
  "data": {
    "booking": {
      "id": "bkg_1",
      "createdAt": "2026-06-14T00:05:00.000Z",
      "updatedAt": "2026-06-14T00:10:00.000Z",
      "departureDate": "2026-06-15T03:30:00.000Z",
      "onboardingDateTime": "2026-06-15T03:30:00.000Z",
      "status": "Upcoming",
      "bookingRequiredBy": null,
      "paymentRequiredBy": null,
      "tickets": [
        {
          "id": "ord_abc",
          "bookingId": "bkg_1",
          "note": null,
          "status": "Processing",
          "paymentStatus": "Prepaid",
          "departureDate": "2026-06-15T00:00:00.000Z",
          "source": "PrexSell",
          "refundAmount": null,
          "prepaid": 300,
          "passenger": {
            "id": "pass_1",
            "firstName": "Іван",
            "lastName": "Петренко",
            "email": "ivan@example.com",
            "phones": [
              {
                "id": "ph_1",
                "phone": "+380501234567",
                "messengers": [
                  "Viber"
                ]
              }
            ]
          },
          "price": {
            "id": "price-1",
            "amount": 1450,
            "currency": "UAH"
          },
          "discount": {
            "id": "disc-1",
            "name": "Студентська знижка",
            "rule": "Percent",
            "amount": 100,
            "startDate": "2026-06-01T00:00:00.000Z",
            "endDate": "2026-12-31T23:59:59.000Z"
          },
          "slices": [
            {
              "id": "sl_abc",
              "duration": 480,
              "departureDate": "2026-06-15T00:00:00.000Z",
              "arrivalDate": "2026-06-15T08:00:00.000Z",
              "seat": {
                "id": "seat_1",
                "label": "12A"
              },
              "bus": {
                "id": "bus-1",
                "seatsQty": 50,
                "registrationNumber": "AA1234BB",
                "brand": "Mercedes-Benz",
                "model": "Tourismo",
                "images": [
                  {
                    "id": "img-1",
                    "url": "https://example.com/bus.jpg",
                    "name": "Bus exterior"
                  }
                ]
              },
              "carriage": {
                "id": "carriage-1",
                "name": "Автопарк №1",
                "phones": [
                  "+380501234567"
                ]
              },
              "route": {
                "id": "route-1",
                "name": "Київ — Варшава",
                "slug": "kyiv-warsaw",
                "description": "Щоденний нічний рейс",
                "company": {
                  "id": "company-1",
                  "name": "PrexSell Lines",
                  "slug": "prexsell-lines",
                  "ceo": "Олена Коваль",
                  "partnerCompany": null,
                  "logoUrl": "https://example.com/logo.png",
                  "email": "ops@prexsell-lines.com",
                  "website": "https://prexsell-lines.com",
                  "rules": "Пасажир має прибути за 20 хвилин до відправлення.",
                  "socials": [
                    "https://facebook.com/prexsell.lines"
                  ]
                },
                "permissions": [
                  {
                    "id": "perm-1",
                    "role": "Agent",
                    "accesses": [
                      "book",
                      "cancel"
                    ],
                    "type": "Partner"
                  }
                ],
                "services": [
                  {
                    "id": "svc-1",
                    "name": "Wi-Fi"
                  },
                  {
                    "id": "svc-2",
                    "name": "Кондиціонер"
                  }
                ]
              },
              "stops": [
                {
                  "id": "stop-1",
                  "departureTime": "06:30",
                  "arrivalTime": null,
                  "platform": "3",
                  "arrivalDate": null,
                  "place": "Центральний автовокзал",
                  "latitude": 50.4501,
                  "longitude": 30.5234,
                  "city": {
                    "id": "city-kyiv",
                    "name": "Київ",
                    "slug": "kyiv",
                    "country": "UA",
                    "timeZone": "Europe/Kyiv"
                  }
                },
                {
                  "id": "stop-2",
                  "departureTime": null,
                  "arrivalTime": "08:00",
                  "platform": "5",
                  "arrivalDate": "2026-06-15T08:00:00.000Z",
                  "place": "Dworzec Zachodni",
                  "latitude": 52.2297,
                  "longitude": 21.0122,
                  "city": {
                    "id": "city-warsaw",
                    "name": "Варшава",
                    "slug": "warsaw",
                    "country": "PL",
                    "timeZone": "Europe/Warsaw"
                  }
                }
              ]
            }
          ]
        }
      ]
    }
  }
}