Short Urls

Short urls are easy ways to share subscription links to your plans.

Create a short url

POST https://api.8pay.network/v1/:chain/variable-recurring/short-urls

Path Parameters

Name	Type	Description
chain	string	chain identifier

Query Parameters

Name	Type	Description
name	string	name of the short url
planId	string	id of the
params	object	object containing short url param
params.callbackSuccess	string	redirect url after success
params.callbackError	string	redirect url after failure
params.extra	string	extra parameters to be sent to webhook

Headers

Name	Type	Description
Authorization	string	Bearer <api-key>

200

{
    "path": "vr46y",
    "name": "Facebook banner",
    "planId": "0x57b2059e526841b3dfd964144513359c9fcfd6d91040b6c47f589c1e032b6bf7",
    "createdAt": 1574954504,
    "updatedAt": 1574954504,
    "params": {
        "callbackSuccess": "https://www.google.com/",
        "callbackError": "https://www.google.com/",
        "extra": {
            "banner": "BR69",
            "traffic": "facebook"
        }
    },
    "link": "https://8pay.me/vr46y"
}

Get a list of short urls

GET https://api.8pay.network/v1/:chain/variable-recurring/short-urls

Retrive a list of short url created by the authenticated user.

Path Parameters

Name	Type	Description
chain	string	chain identifier

Headers

Name	Type	Description
Authorization	string	Bearer <api-key>

200

{
    "data": [
        {
            "path": "vr46y",
            "name": "Facebook banner",
            "planId": "0x57b2059e526841b3dfd964144513359c9fcfd6d91040b6c47f589c1e032b6bf7",
            "createdAt": 1574954504,
            "updatedAt": 1574954504,
            "params": {
                "callbackSuccess": "https://www.google.com/",
                "callbackError": "https://www.google.com/",
                "extra": {
                    "banner": "BR69",
                    "traffic": "facebook"
                }
            },
            "link": "https://8pay.me/vr46y"
        }
    ],
    "limit": 100,
    "offset": 0,
    "total": 1
}

Get short urls of a plan

GET https://api.8pay.network/v1/:chain/variable-recurring/plans/:planId/short-urls

Path Parameters

Name	Type	Description
planId	string	ID of the plan
chain	string	chain identifier

Headers

Name	Type	Description
Authorization	string	Bearer <api-key>

200

{
    "data": [
        {
            "path": "vr46y",
            "name": "Facebook banner",
            "planId": "0x57b2059e526841b3dfd964144513359c9fcfd6d91040b6c47f589c1e032b6bf7",
            "createdAt": 1574954504,
            "updatedAt": 1574954504,
            "params": {
                "callbackSuccess": "https://www.google.com/",
                "callbackError": "https://www.google.com/",
                "extra": {
                    "banner": "BR69",
                    "traffic": "facebook"
                }
            },
            "link": "https://8pay.me/vr46y"
        }
    ],
    "limit": 100,
    "offset": 0,
    "total": 1
}

Get a short url

GET https://api.8pay.network/v1/bsc/variable-recurring/short-urls/:path

Path Parameters

Name	Type	Description
path	string	path of the short url
chain	string	chain identifier

Headers

Name	Type	Description
Authorization	string	Bearer <api-key>

200

{
    "path": "vr46y",
    "name": "Facebook banner",
    "planId": "0x57b2059e526841b3dfd964144513359c9fcfd6d91040b6c47f589c1e032b6bf7",
    "createdAt": 1574954504,
    "updatedAt": 1574954504,
    "params": {
        "callbackSuccess": "https://www.google.com/",
        "callbackError": "https://www.google.com/",
        "extra": {
            "banner": "BR69",
            "traffic": "facebook"
        }
    },
    "link": "https://8pay.me/vr46y"
}

Update a short url

PUT https://api.8pay.network/v1/bsc/variable-recurring/short-urls/:path

Path Parameters

Name	Type	Description
path	string	path of the short url
chain	string	chain identifier

Query Parameters

Name	Type	Description
name	string	name of the short url
planId	string	id of the
params	object	object containing short url param
params.callbackSuccess	string	redirect url after success
params.callbackError	string	redirect url after failure
params.extra	string	extra parameters to be sent to webhook

Headers

Name	Type	Description
Authorization	string	Bearer <api-key>

200

{
    "path": "vr46y",
    "name": "Facebook banner",
    "planId": "0x57b2059e526841b3dfd964144513359c9fcfd6d91040b6c47f589c1e032b6bf7",
    "createdAt": 1574954504,
    "updatedAt": 1574973485,
    "params": {
        "callbackSuccess": "https://www.google.com/",
        "callbackError": "https://www.google.com/",
        "extra": {
            "banner": "BR69",
            "traffic": "facebook"
        }
    },
    "link": "https://8pay.me/vr46y"
}

Delete a short url

DELETE https://api.8pay.network/v1/bsc/variable-recurring/short-urls/:path

Path Parameters

Name	Type	Description
path	string	path of the short url
chain	string	chain identifier

Headers

Name	Type	Description
Authentication	string	Bearer <api-key>

204