Confirm a booking

POST

/api/v5/bookings/{id}/confirm

• Production

Confirms and pays for a booking, lodging it with the selected courier. Requires an API key and booking ownership. A payment-aware retry on an already-paid booking returns 204; returns 402 when payment is declined or fails.

Parameters

Path Parameters

id

required

string

/^\d+$/

Example

623630

Numeric booking ID.

Request Body

object

courier

required

Courier string_id of the selected quote to confirm and pay.

string

>= 1 characters

pickup-date

Requested pickup date (YYYY-MM-DD); hyphenated alias of pickup_date.

string

/^\d{4}-\d{2}-\d{2}$/

pickup_date

Requested pickup date (YYYY-MM-DD); underscore alias of pickup-date.

string

/^\d{4}-\d{2}-\d{2}$/

pickup-time

Any of:

string

string

number

number

pickup_time

Any of:

string

string

number

number

tier

Selected quote tier number when the courier offers multiple tiers.

integer

payment_method

How to pay: “nab_” or “paypal_” (an id from GET /api/members/payment-methods), “credit” to bill your credit account, or “demo” for a sandbox booking. May be sent alongside payment only if the two agree.

string

/^(demo|credit|(nab|paypal)_\d{1,15})$/

payment

One of:

object

object

method

required

Charge the booking to the member account credit balance.

string

Allowed values: credit

object

object

method

required

Pay with a saved NAB credit card.

string

Allowed values: card

card_id

required

Any of:

integer

integer

string

string

/^\d+$/

object

object

method

required

Pay via a stored PayPal billing agreement.

string

Allowed values: paypal

agreement_id

required

Any of:

integer

integer

string

string

/^\d+$/

object

object

method

required

No-charge demo payment (demo-enabled keys only).

string

Allowed values: demo

agreed_terms

Explicit acceptance of the Transdirect Terms and Conditions for this booking. Omitted defaults to the account’s standing acceptance.

boolean

nullable

agreed_warranty

Explicit acceptance of the selected carrier’s Transit Warranty terms for this booking, when the carrier has one. Omitted defaults to the account’s standing acceptance.

boolean

nullable

Responses

204

Booking confirmed, or already-paid payment-aware confirmation retry accepted

400

Invalid booking confirmation request

object

errors

required

Any of:

Array<string>

Array<string>

string

string

object

object

key

additional properties

Any of:

string

string

Array<string>

Array<string>

object

object

message

Validation error message for the field.

string

format

Expected format hint for the field.

string

object

object

key

additional properties

Any of:

string

string

Array<string>

Array<string>

object

object

message

Validation error message for the field.

string

format

Expected format hint for the field.

string

payment_error

Details of the payment gateway failure, when a payment was attempted.

object

code

Gateway error code for the failed payment.

string

nullable

user_message

User-facing message explaining the payment failure.

string

nullable

log_id

Any of:

string

string

number

number

unknown

nullable

method

Payment method that failed, e.g. “card” or “paypal”.

string

nullable

401

Missing or invalid API key

402

Payment declined or failed

object

errors

required

Any of:

Array<string>

Array<string>

string

string

object

object

key

additional properties

Any of:

string

string

Array<string>

Array<string>

object

object

message

Validation error message for the field.

string

format

Expected format hint for the field.

string

object

object

key

additional properties

Any of:

string

string

Array<string>

Array<string>

object

object

message

Validation error message for the field.

string

format

Expected format hint for the field.

string

payment_error

Details of the payment gateway failure, when a payment was attempted.

object

code

Gateway error code for the failed payment.

string

nullable

user_message

User-facing message explaining the payment failure.

string

nullable

log_id

Any of:

string

string

number

number

unknown

nullable

method

Payment method that failed, e.g. “card” or “paypal”.

string

nullable

404

Booking not found

500

Unexpected confirmation failure

object

errors

required

Any of:

Array<string>

Array<string>

string

string

object

object

key

additional properties

Any of:

string

string

Array<string>

Array<string>

object

object

message

Validation error message for the field.

string

format

Expected format hint for the field.

string

object

object

key

additional properties

Any of:

string

string

Array<string>

Array<string>

object

object

message

Validation error message for the field.

string

format

Expected format hint for the field.

string

payment_error

Details of the payment gateway failure, when a payment was attempted.

object

code

Gateway error code for the failed payment.

string

nullable

user_message

User-facing message explaining the payment failure.

string

nullable

log_id

Any of:

string

string

number

number

unknown

nullable

method

Payment method that failed, e.g. “card” or “paypal”.

string

nullable