Skip to content

Pay by invoice

POST/bookings/{id}/pay-by-invoice

Auth: X-API-Key headerhttps://warpdrive.staging.transferz.com/partners

Pays for a booking on invoice (only supported for selected partners)

Pays for the booking on invoice: Transferz invoices you periodically for completed journeys. Only available when invoice payment is enabled for your account. Returns the booking; the journeys move from NOT_PAID to PENDING. Because this happens asynchronously the response can still show NOT_PAID: a successful response means the payment is accepted.

Guides: How a booking works, Pay for a booking

Path parameters

  • idinteger · int64required

    The id of the booking for which to pay on invoice

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Responses

OK

  • idinteger · int64

    Booking id. Store it; there is no search for bookings.

  • codestring

    Booking reference shown to the traveller.

  • partnerReferencestring
  • partnerIdinteger · int64
  • travelIntentenum
    BUSINESS
    Business travel.
    LEISURE
    Leisure travel.
    UNKNOWN
    Not known.
  • bookerInfoobject
  • journeysarray of objects

    The journeys in this booking, one per booked quote.

Errors this endpoint can return

  • When: Invoice payment is not enabled for your account.

    What to do: Use a payment link or Stripe Connect, or ask your partner success manager to enable invoice payments.