Check Order Status

Get order status and retrieve cards when fulfilled

GET /v3/gift-cards/checkOrder/{orderId}

Check Order Status

cURL

curl --request GET \
  --url https://api.oneclickdz.com/v3/gift-cards/checkOrder/{orderId} \
  --header 'X-Access-Token: <api-key>'

200

{
  "data": {
    "status": "<string>",
    "quantity": 123,
    "fulfilled_quantity": 123,
    "fulfilled_amount": 123,
    "price_per_card": 123,
    "cards": [
      {
        "value": "<string>",
        "serial": "<string>"
      }
    ]
  }
}

Overview

Check order status and retrieve card codes when order is fulfilled.

Path Parameters

orderId · string · required

Order ID from /placeOrder response

Response

data · object

Show properties

status · string

• HANDLING: Processing - FULFILLED: Complete, cards available ✅ - PARTIALLY_FILLED: Some cards delivered ⚠️ - REFUNDED: Failed and refunded ❌

quantity · number

Original order quantity

fulfilled_quantity · number

Number of cards delivered

fulfilled_amount · number

Total amount charged

price_per_card · number

Price per card

cards · array

Array of card objects (when FULFILLED or PARTIALLY_FILLED)

Show card object

value · string

Card code/PIN (main credential)

serial · string

Card serial number (secondary credential)

Examples

cURL

curl https://api.oneclickdz.com/v3/gift-cards/checkOrder/6901616fe9e88196b4eb64b3 \
  -H "X-Access-Token: YOUR_API_KEY"

Handling Response

{
  "success": true,
  "data": {
    "_id": "6901616fe9e88196b4eb64b3",
    "status": "HANDLING",
    "quantity": 2,
    "product": "507f1f77bcf86cd799439011",
    "type": "type_001",
    "time": "2025-10-29T01:00:00.000Z"
  }
}

Fulfilled Response

{
  "success": true,
  "data": {
    "_id": "6901616fe9e88196b4eb64b3",
    "status": "FULFILLED",
    "quantity": 2,
    "fulfilled_quantity": 2,
    "fulfilled_amount": 980,
    "price_per_card": 490,
    "cards": [
      {
        "value": "XXXX-XXXX-XXXX-XXXX",
        "serial": "123456789"
      },
      {
        "value": "YYYY-YYYY-YYYY-YYYY",
        "serial": "987654321"
      }
    ],
    "time": "2025-10-29T01:00:00.000Z"
  }
}

Polling Example

async function pollOrder(orderId) {
  const maxAttempts = 60;

  for (let i = 0; i < maxAttempts; i++) {
    const response = await fetch(
      `https://api.oneclickdz.com/v3/gift-cards/checkOrder/${orderId}`,
      { headers: { "X-Access-Token": process.env.API_KEY } }
    );

    const { data } = await response.json();

    if (["FULFILLED", "PARTIALLY_FILLED", "REFUNDED"].includes(data.status)) {
      return data;
    }

    await new Promise((resolve) => setTimeout(resolve, 5000));
  }

  throw new Error("Timeout");
}

Status Handling

FULFILLED

All cards delivered successfully

• fulfilled_quantity === quantity
• All cards available in cards array
• Deliver to customer

PARTIALLY_FILLED

Some cards delivered, rest cancelled

• fulfilled_quantity < quantity
• Partial refund issued
• Deliver available cards
• Refund difference to customer

REFUNDED

Order completely failed

• fulfilled_quantity === 0
• Full refund issued
• Notify customer of failure

Secure Card Delivery

Handle cards securely. Never log card codes in plain text.

// Good: Secure delivery
async function deliverCards(userId, cards) {
  // Store encrypted
  await db.deliveredCards.insertMany(
    cards.map((c) => ({
      userId,
      value: encrypt(c.value),
      serial: encrypt(c.serial),
      deliveredAt: new Date(),
    }))
  );

  // Send via secure channel
  await sendSecureEmail(userId, cards);

  // Log without sensitive data
  logger.info("Cards delivered", { userId, count: cards.length });
}

Related

Place Order

Create new order

List Orders

View all orders