API ReferenceWebhooksSupport

Validate ticket

Validates a ticket using its QR code. Scan the QR code and pass the data and optionally manages metadata entries

POST
/v1/tickets/validate/:qrCode

Authorization

AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Path Parameters

qrCodestring
Length1 <= length

Request Body

metadata?

Response Body

application/json

curl -X POST "https://api.checkoutpage.com/v1/tickets/validate/:qrCode" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "success": true,
    "ticket": {
      "id": "string",
      "sellerId": "string",
      "chargeId": "string",
      "pageId": "string",
      "status": "PAID",
      "orderId": "string",
      "customerName": "string",
      "customerEmail": "string",
      "ticketTypeId": "string",
      "checkIns": [
        {
          "method": "QRSCAN",
          "checkedInAt": "2019-08-24T14:15:22Z",
          "checkedInByUserId": "string",
          "status": "UNCHECKEDIN"
        }
      ],
      "latestCheckIn": {
        "method": "QRSCAN",
        "checkedInAt": "2019-08-24T14:15:22Z",
        "checkedInByUserId": "string",
        "status": "UNCHECKEDIN"
      },
      "ticketShortId": "string",
      "checkInStatus": "UNCHECKEDIN",
      "originalPrice": 0,
      "discountAmount": 0,
      "feeAmount": 0,
      "taxAmount": 0,
      "couponAmount": 0,
      "revenue": 0,
      "currency": "string",
      "livemode": true,
      "metadata": [
        {
          "key": "string",
          "value": "string",
          "addedAt": "2019-08-24T14:15:22Z"
        }
      ],
      "orderedAt": "2019-08-24T14:15:22Z",
      "canceledAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "message": "string"
  }
}
Empty
Empty
Empty
Empty
Empty
Empty