Skip to main content
GET
/
api
/
orders
/
:id
curl -X GET https://api.gatepass.io/api/orders/clx1234567890abcdef \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "id": "clx1234567890abcdef",
  "totalAmount": 102.50,
  "quantity": 2,
  "currency": "NGN",
  "paymentMethod": "FIAT",
  "paymentStatus": "COMPLETED",
  "customerEmail": "customer@example.com",
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/GoodnessFx/GatePass/llms.txt

Use this file to discover all available pages before exploring further.

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)
​
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
​
tickets
array
Array of ticket objects associated with this order
​
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 -X GET https://api.gatepass.io/api/orders/clx1234567890abcdef \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "id": "clx1234567890abcdef",
  "totalAmount": 102.50,
  "quantity": 2,
  "currency": "NGN",
  "paymentMethod": "FIAT",
  "paymentStatus": "COMPLETED",
  "customerEmail": "customer@example.com",
  "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

Build docs developers (and LLMs) love

Get started for freeTalk to us