API Documentation

SERVICES

UniPin TopUp Shell Fulfillment Utility Tools

API Documentation

Integrate our rapid gaming fulfillment engine directly into your software or website. Each request carries a flat service fee.

UniPin TopUp API

v1.0 Stable

Base URL: https://tzapi.tzsmm.com

1. Authentication

Send your X-API-KEY in the request header (recommended) or as a query parameter.

X-API-KEY: YOUR_SECRET_KEY

GET /api/v1/user/packages?api_key=YOUR_SECRET_KEY

2. List Packages

Fetch all active UniPin packages to get their id for order creation.

GET https://tzapi.tzsmm.com/api/v1/user/packages

                                            SUCCESS RESPONSE
{
    "status": "success",
    "data": [
                { "id": 25, "name": "25 Diamond" },                { "id": 50, "name": "50 Diamond" },                { "id": 115, "name": "115 Diamond" }            ],
    "fee_per_request": 0.5
}
                                        

UniPin Package ID Reference:

Package Name	ID (Input)
25 Diamond	`25`
50 Diamond	`50`
115 Diamond	`115`
Weekly Membership	`161`
240 Diamond	`240`
610 Diamond	`610`
Monthly Membership	`800`
1240 Diamond	`1240`
2530 Diamond	`2530`

3. Create TopUp Order

Initiate an automated voucher redemption request.

POST https://tzapi.tzsmm.com/api/v1/user/order/create

Parameter	Type	Aliases (Alternative Names)	Description
playerid	String	`player_id`, `p_id`	Target Player ID (min 8 digits).
package	Int	`package_id`, `pacakge`	Package ID from step 2.
code	String	-	Voucher PIN (Validated for 8/16 digit patterns).
orderid	String	`user_order_id`	(Optional) Your internal order reference.
callback_url	URL	`url`	(Optional) URL for POST updates.

{
    "status": "success",
    "order_id": "TZUP-ABCD12345678",
    "message": "Order created and pending fulfillment."
}
                                                

{
    "status": "error",
    "message": "Validation failed",
    "errors": {
        "playerid": ["The playerid must be at least 8 characters."],
        "code": ["The code format is invalid."]
    }
}
                                                

4. Check Order Status

Fetch details for a specific order by our ID or your tracking ID.

GET / ANY https://tzapi.tzsmm.com/api/v1/user/order/status

Params: order_id OR user_order_id

                                            RESPONSE EXAMPLE
{
    "status": "success",
    "data": {
        "orderid": "TRACK-001",
        "api_order_id": "TZUP-ABCD12345678",
        "status": "success",
        "package": "UniPin 100 Diamonds",
        "message": "Topup successful! Automation complete.",
        "created_at": "2026-04-06 12:00:00"
    }
}
                                        

5. Webhook (Callback) Updates

We will POST a JSON payload to your callback_url for terminal status changes (Success/Failed).

{
    "status": "success",
    "api_order_id": "TZUP-ABCD12345678",
    "orderid": "TRACK-001",
    "player_id": "12345678",
    "package": "UniPin 50 Diamonds",
    "message": "Top-up success!"
}
                                                

{
    "status": "failed",
    "api_order_id": "TZUP-ABCD12345678",
    "orderid": "TRACK-001",
    "player_id": "12345678",
    "message": "Voucher already redeemed. System has automatically refunded balance."
}
                                                

Utility Tools

Helper endpoints for integration.

1. Generate TOTP Code

Convert a Base32 Secret Key into a live 6-digit Google Authenticator code.

GET https://tzapi.tzsmm.com/api/v1/user/otp

Params: key (Your Base32 Secret Key)

                                                SUCCESS RESPONSE
{
    "status": "success",
    "code": "123456",
    "expires_in": 24
}
                                            

SERVICES