OFFICIAL DEVELOPER REFERENCE

Biriq Reseller API

A high-performance RESTful API designed for resellers and partner 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

GET/me

Account Information

Returns profile details, current wallet status, and reseller account permissions.

cURL Request

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

Example Response (200 OK)

{
  "account": {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "username": "reseller_partner",
    "name": "Partner Gaming Store",
    "email": "partner@example.com",
    "role": "reseller",
    "balance_cents": 10000,
    "mfa_enabled": true
  }
}

GET/balance

Wallet Balance

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

cURL Request

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

Example Response (200 OK)

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

GET/catalog

Product Catalog Discovery

Lists all available game top-up titles, denominations, and gift card brands.

cURL Request

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

Example Response (200 OK)

{
  "synced_at": "2026-10-12T04:30:00.000Z",
  "games": [
    {
      "id": "pubgm",
      "name": "PUBG Mobile",
      "code": "pubgm",
      "packages_count": 14
    },
    {
      "id": "freefire",
      "name": "Free Fire",
      "code": "freefire",
      "packages_count": 12
    }
  ],
  "categories": [
    {
      "id": "itunes-us",
      "title": "Apple iTunes (US)",
      "products_count": 8
    }
  ]
}

GET/products?game=pubgm

Live Product Pricing

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

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

cURL Request

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

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
    }
  ]
}

POST/player/validate

Validate Player ID

Verifies the player user ID and returns their in-game nickname before ordering.

Parameter	Type	Required	Description
`game`	string	Yes	Game code (e.g. pubgm)
`user_id`	string	Yes	Player ID number
`server_id`	string	Optional	Server/Zone ID if required

cURL Request

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

Example Response (200 OK)

{
  "valid": true,
  "name": "BIRIQ STORE",
  "message": "Player verified successfully"
}

POST/orders

Place Order

Submits a live top-up or gift card voucher order and debits your wallet.

cURL Request

curl -X POST "https://api.biriqstore.com/api/v1/orders" \
  -H "X-API-Key: YOUR_API_KEY" \
  -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"
  }
}

GET/orders/:id

Check Order Status

Checks fulfillment status of an order and retrieves voucher codes upon completion.

cURL Request

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

Example Response (200 OK)

{
  "order": {
    "id": "c56a4180-65aa-42ec-a945-5fd21dec0538",
    "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"
  ]
}

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.