app.brolexy.com API Docs

API Environment

Brolexy API is available in two separate environments: Production and Development.

Please make sure you are using the correct base URL depending on the environment you want to access.

Use the Production API for real orders and live operations. Use the Development API for testing, integration checks, and sandbox requests.

  • [GET] Request accounts and their balances

    Headers

    HeaderValueDescription
    publicKey{publicKey}Public key
    time{time}Unix timestamp
    signaturebase64(HmacSHA256({time}))Signature of
    message

    Note: HmacSHA256 must return a string value first, and then this string should be encoded with Base64. Do not Base64-encode the raw binary HMAC output directly.

    • ✅ Response 200
      [
    {
        "id": 1,
        "balance": "450.36",
        "currency": "EUR",
        "status": "ACTIVE"
    },
    {
        "id": 3,
        "balance": "0.00",
        "currency": "GBP",
        "status": "BLOCKED"
    }
]
    • ✅ Response 403
      {
    "code": 403,
    "text": "{error_text}",
    "message": {"error_description"}
}

  • [GET] Request available products

    Headers

    HeaderValueDescription
    publicKey{publicKey}Public key
    time{time}Unix timestamp
    signaturebase64(HmacSHA256({time}))Signature of
    message
    • ✅ Response 200
      [
    {
        "productId": 7,
        "category": "PSN",
        "region": "FI",
        "name": "PSN 5 EUR Finland",
        "price": "5.11",
        "priceCurrency": "EUR",
        "inStock": 6
    },
    {
        "productId": 8,
        "category": "PSN",
        "region": "FI",
        "name": "PSN 10 EUR Finland",
        "price": "10.02",
        "priceCurrency": "EUR",
        "inStock": 2
    }
]
    • ✅ Response 403
      {
    "code": 403,
    "text": "{error_text}",
    "message": {"error_description"}
}

  • [GET] Get single product by Id
    URL/product?productId={productId}

    Headers

    HeaderValueDescription
    publicKey{publicKey}Public key
    time{time}Unix timestamp
    signaturebase64(HmacSHA256({time}.{productId}))Signature of
    message
    • ✅ Response 200
      [
    {
        "productId": 7,
        "category": "PSN",
        "region": "FI",
        "name": "PSN 5 EUR Finland",
        "price": "5.11",
        "priceCurrency": "EUR",
        "inStock": 6
    }
]
    • ✅ Response 403
      {
    "code": 403,
    "text": "{error_text}",
    "message": {"error_description"}
}

  • [POST] Submit order

    Headers

    HeaderValueDescription
    publicKey{publicKey}Public key
    time{time}Unix timestamp
    signaturebase64(HmacSHA256({time}.{productID}.{quantity}))Signature of
    message
    Content-Typeapplication/jsonContent-Type

    Note: The dots and brackets in base64(HmacSHA256({time}.{productID}.{quantity})) are shown only as notation for concatenation and placeholders. Do not include dots or brackets in the actual message string. Example: if time = 1710000000, productID = 12345, and quantity = 2, the message to sign should be 1710000000123452.

    Body

    {
    "accountID": 1,
    "productID": 7,
    "quantity": 2
}

    Body (optional)

    You can optionally provide a unique client order identifier to facilitate future inquiries about a specific order. This field should be a string containing only permitted characters: uppercase and lowercase letters (A-Z, a-z) and digits (0-9). Maximum length is 64 characters.

    {
    "accountID": 1,
    "productID": 7,
    "quantity": 2,
    "referenceID": "{referenceID}"
}
    • ✅ Response 200
      {
    "status": "SUCCESS",
    "orderID": "api_66c6005f6b62b485703184",
    "product": "PSN 5 EUR Finland",
    "pins": [
        {
            "pin": "testcode2"
        },
        {
            "pin": "testcode1"
        }
    ]
}
    • ✅ Response 403
      {
    "code": 403,
    "text": "{error_text}",
    "message": {"error_description"}
}

  • [GET] Request order information
    URL/get-order?referenceID={referenceID}

    Headers

    HeaderValueDescription
    publicKey{publicKey}Public key
    time{time}Unix timestamp
    signaturebase64(HmacSHA256({time}.{referenceID}))Signature of
    message
    • ✅ Response 200
      {
    "status": "SUCCESS",
    "orderID": "api_66c6005f6b62b485703184",
    "product": "PSN 5 EUR Finland",
    "pins": [
        {
            "pin": "testcode2"
        },
        {
            "pin": "testcode1"
        }
    ]
}
    • ✅ Response 403
      {
    "code": 403,
    "text": "{error_text}",
    "message": {"error_description"}
}