Book an offer
POST/v1/transfer/book
Books a rechecked offer. Allow up to 150 seconds. Idempotent per internal_reference: TransferPlatform records the attempt before calling the provider; re-sending the identical request returns the original booking (Idempotent-Replayed: true), and a different request, or one while the first is in progress or unknown, answers 409 duplicate_booking without booking. A declined booking answers 200 with status: failed; a provider that did not answer in time 200 with status: unknown (re-send the identical request later). 409 offer_expired / 409 currency_unavailable / 422 invalid_offer_token as for recheck.
Guides: Booking flow, Idempotency & retries.
Request
Responses
- 200
- 401
- 403
- 409
- 413
- 422
- 429
- 500
- 503
Booking outcome (completed, pending, failed or unknown). Header Idempotent-Replayed: true when this is the stored response of an earlier identical request.
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Present when the response is the stored result of an earlier identical request (no new provider call).
Missing or invalid API key (unauthorized). Header WWW-Authenticate: ApiKey header="X-API-Key".
Response Headers
ApiKey header="X-API-Key"
Provider not enabled for this API key (provider_not_enabled).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
duplicate_booking: this internal_reference belongs to a booking that is in progress, unknown, or a different request (nothing was booked by this call); or the offer expired / cannot be priced (search again).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Request body larger than 256 KB (payload_too_large).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Invalid request body (validation_error), or a missing / modified / foreign token (invalid_offer_token).
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Rate limit exceeded for this API key (rate_limited). Wait Retry-After seconds.
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Seconds to wait before retrying.
Unexpected error (internal_error); no details are returned. Report it with the request_id.
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.
Authentication or booking records temporarily unavailable (auth_unavailable, service_unavailable). Nothing reached a provider. Retry with backoff.
Response Headers
Id of this request (yours if you sent a valid one). Quote it to support.