Welcome to

The best way to monetize

your private server

API Docs

To get started using the API, ensure that you have created your store and received your API key via the dashboard. You'll need to send this key with every request in the headers as Authorization: Bearer your_code_here. This lets us know who is using the api and thus getting you the correct information.

Api URL: https://api.runepay.app

Endpoints
GET /payments Returns a list of payements sorted by newest first. (max. 1000 results)
GET /payments/{trans_id} Returns a list of payments based on transaction id.
GET /payments/user/{username} Returns a list of payments belonging to a specific username
GET /payments/user/{username}/pending Returns a list of unclaimed payments belonging to a specific username.

GET /payments

Return a list of your latest payments, sorted by newest first.

Query String Params
Field Type Description Default
limit integer Max number of payments to show (1-1000) 500
Error output:
            
                { "error": "error message" }
            
        

GET /payments/{transaction_id}

Return a list of your latest payments for a given transaction id, sorted by newest first. This will not return Stripe payments due to the lack of a transaction id.

Query String Params
Field Type Description Default
limit integer Max number of payments to show (1-1000) 500
Error output:
            
                { "error": "error message" }
            
        

GET /payments/user/{username}

Return a list of your latest payments for a given username, sorted by newest first.

Query String Params
Field Type Description Default
limit integer Max number of payments to show (1-1000) 500
Error output:
            
                { "error": "error message" }
            
        
Expected Output
                
                    [
                        {
                            "id": 33,
                            "store_id": "1",
                            "product_id": 2,
                            "status": "completed",
                            "quantity": 1,
                            "paid": 9,
                            "processor": "paypal",
                            "paid_by": "OGKingFox",
                            "ip_address": "::1",
                            "manual": false,
                            "email": "[email protected]",
                            "trans_id": "8GH22961W81188806",
                            "claimed": false,
                            "stripe_sess": null,
                            "date_paid": 1615492304,
                            "stores_product": {
                                "id": 2,
                                "item_name": "Test Product",
                                "price": 10,
                                "item_id": -1,
                                "image_url": null
                            }
                        }
                    ]
                
            

GET /payments/user/{username}/pending

Return a list of your latest payments for a given username that have not yet been claimed. Appending ?autoClaim=true will automatically set them as claimed so they can't be pulled again.

Query String Params
Field Type Description Default
limit integer Max number of payments to show (1-1000) 500
autoClaim boolean (true or false) Set claimed to true upon being called. false
Error output:
            
                { "error": "error message" }
            
        
Expected Output
                
                    [
                        {
                            "id": 33,
                            "store_id": "1",
                            "product_id": 2,
                            "status": "completed",
                            "quantity": 1,
                            "paid": 9,
                            "processor": "paypal",
                            "paid_by": "OGKingFox",
                            "ip_address": "::1",
                            "manual": false,
                            "email": "[email protected]",
                            "trans_id": "8GH22961W81188806",
                            "claimed": false,
                            "stripe_sess": null,
                            "date_paid": 1615492304,
                            "stores_product": {
                                "id": 2,
                                "item_name": "Test Product",
                                "price": 10,
                                "item_id": -1,
                                "image_url": null
                            }
                        }
                    ]