OFFICIAL DEVELOPER REFERENCE

Biriq Reseller API

A high-performance RESTful API designed for resellers, store fronts, and bot applications. Automate game top-ups, voucher delivery, wallet checks, and instant player validations directly from your systems.

BASE URL

https://api.biriqstore.com/api/v1

Authentication

Every request to the Biriq Reseller API requires an authenticated API key passed via the X-API-Key request header.

You can generate a personal API key inside your Biriq Workspace → API keys tab. Always keep your secret keys private on server-side environments; never expose them to front-end browser clients.

Example Header

X-API-Key: bq_live_your_api_key_here

Gift Card Categories

Lists all available digital voucher and gift card brands (e.g. Apple iTunes, Razer Gold, PlayStation, Steam).

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/categories" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "categories": [
    {
      "id": "itunes-us",
      "title": "Apple iTunes (US)",
      "products_count": 8
    },
    {
      "id": "razer-gold-global",
      "title": "Razer Gold (Global)",
      "products_count": 6
    },
    {
      "id": "playstation-us",
      "title": "PlayStation Network (US)",
      "products_count": 5
    },
    {
      "id": "steam-global",
      "title": "Steam Wallet (Global)",
      "products_count": 7
    }
  ]
}

Games & Input Fields

Retrieves all available game top-up titles, available packages, and player ID / server ID field specifications.

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/games" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "games": [
    {
      "id": "pubgm",
      "code": "pubgm",
      "name": "PUBG Mobile",
      "fields": [
        {
          "name": "user_id",
          "required": true,
          "label": "Player ID"
        }
      ],
      "packages": [
        {
          "id": 264,
          "name": "60 UC",
          "sale_price": 0.97
        },
        {
          "id": 265,
          "name": "325 UC",
          "sale_price": 4.85
        }
      ]
    },
    {
      "id": "mlbb",
      "code": "mlbb",
      "name": "Mobile Legends",
      "fields": [
        {
          "name": "user_id",
          "required": true,
          "label": "User ID"
        },
        {
          "name": "server_id",
          "required": true,
          "label": "Zone / Server ID"
        }
      ],
      "packages": [
        {
          "id": 101,
          "name": "86 Diamonds",
          "sale_price": 1.45
        }
      ]
    }
  ]
}

Live Product Pricing

Fetches real-time prices for items within a specific game or gift card category.

Parameters

Parameter	Type	Required	Description
`game`	string	Optional	Game code (e.g. pubgm, freefire, mlbb)
`category_id`	string	Optional	Category ID for gift card vouchers (e.g. itunes-us)

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/products?game=pubgm" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "price_checked_at": "2026-10-12T04:35:00.000Z",
  "currency": "USD",
  "products": [
    {
      "id": 264,
      "name": "60 UC",
      "title": "60 UC",
      "sale_price": 0.97,
      "stock": null
    },
    {
      "id": 265,
      "name": "325 UC",
      "title": "325 UC",
      "sale_price": 4.85,
      "stock": null
    }
  ]
}

Full Catalog Snapshot

Returns the full catalog including all games, gift card brands, denominations, and status.

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/catalog" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "synced_at": "2026-10-12T04:30:00.000Z",
  "games_count": 229,
  "categories_count": 169,
  "pricing_mode": "live_supplier_plus_markup"
}

Validate Player ID

Verifies the player account in-game and returns their verified nickname. Also accepts /games/checkPlayerId.

Parameters

Parameter	Type	Required	Description
`game`	string	Yes	Game code (e.g. pubgm, mlbb, freefire)
`user_id`	string	Yes	Player ID or User ID
`server_id`	string	Optional	Zone / Server ID if required (e.g. for MLBB)

cURL Request

curl -X POST "https://api.biriqstore.com/api/v1/player/validate" \
  -H "X-API-Key: bq_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "game": "pubgm",
  "user_id": "5492598608"
}'

Example Response (200 OK)

{
  "valid": "valid",
  "is_valid": true,
  "name": "BIRIQīSTORE",
  "openid": null,
  "game": "pubgm",
  "user_id": "5492598608",
  "message": "Player found."
}

Place Top-up Order

Submits a direct in-game top-up order and debits your reseller wallet. Also accepts /games/order.

cURL Request

curl -X POST "https://api.biriqstore.com/api/v1/orders" \
  -H "X-API-Key: bq_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "request_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  "type": "topup",
  "game": "pubgm",
  "product_id": 264,
  "player_id": "5492598608",
  "expected_price": 0.97
}'

Example Response (200 OK)

{
  "order": {
    "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
    "type": "topup",
    "product": "60 UC",
    "player": "5492598608",
    "status": "pending",
    "sale_micros": 970000,
    "created_at": "2026-10-12T04:40:00.000Z"
  }
}

Buy Gift Card / Voucher

Purchases a digital gift card voucher code. Also accepts /buy.

cURL Request

curl -X POST "https://api.biriqstore.com/api/v1/orders" \
  -H "X-API-Key: bq_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "request_id": "e71b2901-38aa-41ac-bc11-8fa31def0642",
  "type": "voucher",
  "product_id": 512,
  "expected_price": 10
}'

Example Response (200 OK)

{
  "order": {
    "id": "e71b2901-38aa-41ac-bc11-8fa31def0642",
    "type": "voucher",
    "product": "iTunes $10 US",
    "status": "completed",
    "sale_micros": 10000000,
    "created_at": "2026-10-12T04:40:00.000Z"
  },
  "codes": [
    "XX99-ABCD-EFGH-1234"
  ]
}

Check Order Status & Delivery

Checks fulfillment status of an order and retrieves digital PIN codes upon completion. Also accepts /delivery/:id.

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/orders/:id" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "order": {
    "id": "e71b2901-38aa-41ac-bc11-8fa31def0642",
    "type": "voucher",
    "product": "iTunes $10 US",
    "status": "completed",
    "sale_micros": 10000000,
    "created_at": "2026-10-12T04:40:00.000Z",
    "completed_at": "2026-10-12T04:40:05.000Z"
  },
  "codes": [
    "XX99-ABCD-EFGH-1234"
  ]
}

Status Polling (POST)

Alternative status polling endpoint compatible with standard aggregator formats.

cURL Request

curl -X POST "https://api.biriqstore.com/api/v1/games/order/status" \
  -H "X-API-Key: bq_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "order_id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
  "game": "pubgm"
}'

Example Response (200 OK)

{
  "order": {
    "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
    "status": "completed",
    "completed_at": "2026-10-12T04:40:15.000Z"
  }
}

List Orders History

Retrieves your recent orders with date filtering and status indicators.

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/orders?from=2026-10-01&to=2026-10-12" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "orders": [
    {
      "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
      "type": "topup",
      "product": "60 UC",
      "player": "5492598608",
      "status": "completed",
      "sale_micros": 970000,
      "created_at": "2026-10-12T04:40:00.000Z"
    }
  ],
  "limit": 1000
}

Account Information

Returns profile details, current wallet status, and reseller account permissions. Also accepts /getMe.

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/me" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "account": {
    "id": "02879825-ab20-48ef-91d1-6ea6a09b5489",
    "username": "reseller_partner",
    "name": "Partner Gaming Store",
    "email": "partner@example.com",
    "role": "reseller",
    "balance_cents": 10000,
    "mfa_enabled": false
  },
  "balance": "100.00",
  "currency": "USD"
}

Wallet Balance

Retrieves your current available wallet balance in USD ready for instant orders.

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/balance" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "balance": "100.00",
  "balance_cents": 10000,
  "currency": "USD"
}

Wallet Transactions

Lists recent ledger transactions including top-ups, deposits, order debits, and automatic refunds.

cURL Request

curl -X GET "https://api.biriqstore.com/api/v1/transactions" \
  -H "X-API-Key: bq_live_your_api_key_here"

Example Response (200 OK)

{
  "transactions": [
    {
      "id": "9f1a28cb-128a-49bf-a81d-72fb1c49b089",
      "kind": "order_purchase",
      "amount_cents": -97,
      "before_cents": 10000,
      "after_cents": 9903,
      "note": "Topup PUBG Mobile 60 UC",
      "created_at": "2026-10-12T04:40:00.000Z"
    }
  ],
  "count": 1
}

Errors & Rate Limits

The API returns standard HTTP status codes. Failed responses include an informative JSON object containing an error message.

Status Code	Meaning	Description
`200 OK`	Success	Request was successfully processed.
`400 Bad Request`	Invalid Request	Missing required parameters or malformed body.
`401 Unauthorized`	Authentication Failed	Invalid, revoked or missing API key.
`403 Forbidden`	Access Denied	Key lacks the required scope (e.g. read-only key attempting to place orders).
`404 Not Found`	Resource Not Found	Order ID or endpoint does not exist.
`409 Conflict`	Wallet / State Issue	Insufficient wallet balance or price changed since quote.
`429 Too Many Requests`	Rate Limited	Exceeded 120 requests per minute limit. Back off before retrying.