Get a booking
GET/bookings/:bookingId
The booking is the source of truth. nextAction tells you what to do with the hold. Another partner's
booking, or one that does not exist, is 404 NOT_FOUND. A booking stays readable after an activity is
withdrawn from you, and capture or release reports are still accepted for it.
bookingStatus | paymentStatus | nextAction | You do |
|---|---|---|---|
pending | authorized | none | Wait. |
approved | authorized | capture_payment | Capture once, then report capture_succeeded or capture_failed. |
approved | capture_failed | capture_payment | Try again, or cancel the booking. |
completed | authorized or capture_failed | capture_payment | The activity took place before you captured. Capture now. |
approved or completed | captured | none | Nothing. |
declined or cancelled | authorized or capture_failed | release_hold | Release the hold, then report hold_released. For a decline, show declineReason. |
declined or cancelled | captured | none | The booking ended after you captured. Refund your customer; nothing is owed to All Out for it. |
declined or cancelled | released | none | Nothing. |
An approved booking can still be declined or cancelled later. Act on the latest state each time.
Request
Responses
- 200
- 401
- 403
- 404
- 429
The booking.
No token, an expired token, or wrong credentials (UNAUTHORIZED). Get a new token.
Your account is suspended (PARTNER_DISABLED), whatever token you hold. Contact All Out.
Not yours, not assigned to you, or does not exist (NOT_FOUND). Also a path or method that does not exist.
Too many requests (RATE_LIMITED). Wait the seconds in the Retry-After header.
Response Headers
Seconds to wait.