Get Order

Retrieve details for a specific order

GET /api/orders/:id

cURL

curl -X GET https://api.gatepass.io/api/orders/clx1234567890abcdef \
  -H "Authorization: Bearer YOUR_TOKEN"

Success Response

{
  "id": "clx1234567890abcdef",
  "totalAmount": 102.50,
  "quantity": 2,
  "currency": "NGN",
  "paymentMethod": "FIAT",
  "paymentStatus": "COMPLETED",
  "customerEmail": "[e-mail]",
  "customerName": "John Doe",
  "billingAddress": {
    "street": "123 Main Street",
    "city": "Lagos",
    "state": "Lagos State",
    "country": "Nigeria",
    "postalCode": "100001"
  },
  "flutterwaveReference": "GP-clx1234567890-1234567890-a1b2c3d4",
  "paymentTxId": "FLW-TX-123456789",
  "event": {
    "id": "clx1234567890",
    "title": "Tech Conference 2024",
    "description": "Annual technology conference featuring industry leaders",
    "venue": "Convention Center Lagos",
    "address": "1 Water Corporation Drive, Victoria Island",
    "city": "Lagos",
    "country": "Nigeria",
    "eventDate": "2024-06-15T10:00:00Z",
    "imageUrl": "https://cdn.gatepass.io/events/tech-conf-2024.jpg",
    "category": "CONFERENCE"
  },
  "tickets": [
    {
      "id": "clx1111111111111111",
      "tokenId": 1001,
      "contractAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
      "chainId": 137,
      "txHash": "0xabc123def456...",
      "metadataUri": "ipfs://QmX...",
      "tier": "VIP",
      "seatNumber": "A-15",
      "section": "Front Row",
      "isUsed": false,
      "usedAt": null
    },
    {
      "id": "clx2222222222222222",
      "tokenId": 1002,
      "contractAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
      "chainId": 137,
      "txHash": "0xdef456abc789...",
      "metadataUri": "ipfs://QmY...",
      "tier": "VIP",
      "seatNumber": "A-16",
      "section": "Front Row",
      "isUsed": false,
      "usedAt": null
    }
  ],
  "userId": "clx9999999999999999",
  "createdAt": "2024-05-20T14:30:00Z",
  "updatedAt": "2024-05-20T14:35:00Z"
}

Get comprehensive details about a single order, including payment information, associated tickets, and event details.

Authentication

Authorization · string · required

Bearer token for authentication

Path Parameters

id · string · required

The unique identifier of the order

Response

id · string

Unique order identifier

totalAmount · number

Total order amount including platform fees

quantity · number

Number of tickets purchased

currency · string

Payment currency (NGN, USD, ETH, etc.)

paymentMethod · string

Payment method: CRYPTO or FIAT

paymentStatus · string

Order status: PENDING, COMPLETED, or FAILED

customerEmail · string

Customer email address

customerName · string

Customer name

billingAddress · object

Billing address information (if provided)

Show Address Object

street · string

Street address

city · string

City

state · string

State or province

country · string

Country

postalCode · string

Postal or ZIP code

paystackReference · string

Paystack payment reference (if applicable)

flutterwaveReference · string

Flutterwave payment reference (if applicable)

blockchainTxHash · string

Blockchain transaction hash for crypto payments

paymentTxId · string

Payment gateway transaction ID

event · object

Associated event details

Show Event Object

id · string

Event ID

title · string

Event title

description · string

Event description

venue · string

Event venue

address · string

Full venue address

city · string

City

country · string

Country

eventDate · string

Event date and time (ISO 8601)

imageUrl · string

Event image URL

category · string

Event category

tickets · array

Array of ticket objects associated with this order

Show Ticket Object

id · string

Ticket ID

tokenId · number

NFT token ID on the blockchain

contractAddress · string

Smart contract address

chainId · number

Blockchain chain ID (e.g., 137 for Polygon)

txHash · string

Minting transaction hash

metadataUri · string

IPFS URI for ticket metadata

tier · string

Ticket tier name

seatNumber · string

Seat number (if assigned seating)

section · string

Venue section

isUsed · boolean

Whether the ticket has been used for check-in

usedAt · string

Check-in timestamp (ISO 8601)

userId · string

ID of the user who placed the order

createdAt · string

Order creation timestamp (ISO 8601)

updatedAt · string

Last update timestamp (ISO 8601)

cURL

curl -X GET https://api.gatepass.io/api/orders/clx1234567890abcdef \
  -H "Authorization: Bearer YOUR_TOKEN"

Success Response

{
  "id": "clx1234567890abcdef",
  "totalAmount": 102.50,
  "quantity": 2,
  "currency": "NGN",
  "paymentMethod": "FIAT",
  "paymentStatus": "COMPLETED",
  "customerEmail": "[e-mail]",
  "customerName": "John Doe",
  "billingAddress": {
    "street": "123 Main Street",
    "city": "Lagos",
    "state": "Lagos State",
    "country": "Nigeria",
    "postalCode": "100001"
  },
  "flutterwaveReference": "GP-clx1234567890-1234567890-a1b2c3d4",
  "paymentTxId": "FLW-TX-123456789",
  "event": {
    "id": "clx1234567890",
    "title": "Tech Conference 2024",
    "description": "Annual technology conference featuring industry leaders",
    "venue": "Convention Center Lagos",
    "address": "1 Water Corporation Drive, Victoria Island",
    "city": "Lagos",
    "country": "Nigeria",
    "eventDate": "2024-06-15T10:00:00Z",
    "imageUrl": "https://cdn.gatepass.io/events/tech-conf-2024.jpg",
    "category": "CONFERENCE"
  },
  "tickets": [
    {
      "id": "clx1111111111111111",
      "tokenId": 1001,
      "contractAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
      "chainId": 137,
      "txHash": "0xabc123def456...",
      "metadataUri": "ipfs://QmX...",
      "tier": "VIP",
      "seatNumber": "A-15",
      "section": "Front Row",
      "isUsed": false,
      "usedAt": null
    },
    {
      "id": "clx2222222222222222",
      "tokenId": 1002,
      "contractAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
      "chainId": 137,
      "txHash": "0xdef456abc789...",
      "metadataUri": "ipfs://QmY...",
      "tier": "VIP",
      "seatNumber": "A-16",
      "section": "Front Row",
      "isUsed": false,
      "usedAt": null
    }
  ],
  "userId": "clx9999999999999999",
  "createdAt": "2024-05-20T14:30:00Z",
  "updatedAt": "2024-05-20T14:35:00Z"
}

Access Control

Users can only access their own orders. Attempting to retrieve another user’s order will result in a 403 Forbidden error.

The tickets array contains all NFT tickets minted for this order. Each ticket includes blockchain information and can be used for event check-in.

Blockchain Information

For crypto payments or NFT tickets, the response includes blockchain-specific fields:

• contractAddress: Smart contract where tickets are minted
• chainId: Blockchain network (137 = Polygon, 1 = Ethereum)
• txHash: Transaction hash for verification
• tokenId: Unique NFT token identifier