Skip to main content
POST
/
api
/
v1
/
driver
/
checkout-sessions
/
{checkoutSessionId}
/
confirm
Confirm Checkout Session
curl --request POST \
  --url https://api.example.com/api/v1/driver/checkout-sessions/{checkoutSessionId}/confirm \
  --header 'Authorization: Bearer <token>'
{
  "checkoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "ticketIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "checkoutSession": {
    "checkoutSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tripId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expiresAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tripItineraryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "seatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "qrToken": "<string>",
    "passengerDraft": {
      "name": "Mariana Costa",
      "document": "12345678909",
      "documentType": "CPF",
      "birthDate": "1992-04-18"
    },
    "requestedCreditAmount": 1,
    "promotionalCode": "<string>",
    "linkedAt": "2023-11-07T05:31:56Z",
    "preparedAt": "2023-11-07T05:31:56Z",
    "confirmedAt": "2023-11-07T05:31:56Z",
    "canceledBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "canceledAt": "2023-11-07T05:31:56Z",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
checkoutSessionId
string<uuid>
required

Checkout session identifier.

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

OK

Confirmation result for a checkout session.

​
checkoutId
string<uuid>
required

Checkout created by the confirmation.

​
orderIds
string<uuid>[]
required

Orders created by the checkout.

​
ticketIds
string<uuid>[]
required

Tickets issued by the checkout.

​
checkoutSession
object
required

Checkout session linked by the customer app through a QR token.