PayNow

Webstore Routes

A convenient list of all webstore HTTP routes.

Endpoints

GET
/
GET
/products
GET
/products/{product.slug}
POST
/products/{product.slug}/checkout
GET
/cart
POST
/cart/add/{product.slug}
POST
/cart/set/{product.slug}
POST
/cart/remove/{product.slug}
POST
/cart/empty
POST
/cart/checkout
POST
/auth/sign-in
POST
/auth/sign-out
GET
/subscriptions
POST
/subscriptions/{subscription.id}/cancel
GET
/complete
GET
/legal/terms-of-service
GET
/legal/user-agreement
GET
/legal/privacy-policy

Index

Renders the index.html template file.

Request

GET
/

Products

Renders the category.html template file.

  • Query Parameters

  • Name
    tags
    Type
    string[]?
    Tags
    OPTIONAL
    Description

    A comma separated array of tag slugs to filter by

Request

GET
/products

View Product

Renders the product.html template file.

Request

GET
/products/{product.slug}

Checkout Product

Checks out the supplied product and redirects to checkout/cart.

  • Query Parameters

  • Name
    cart
    Type
    boolean?
    Tags
    OPTIONAL
    Description

    Should the product be added to a cart instead of redirecting to checkout?

    Only available for non-subscription products.

  • Name
    subscription
    Type
    boolean?
    Tags
    OPTIONAL
    Description

    Should the product be added as a subscription? Use true or false.

  • Name
    quantity
    Type
    int?
    Tags
    OPTIONAL
    Description

    The quantity of the product selected by the customer. Defaults to 1.

  • Name
    gift_to
    Type
    string?
    Tags
    OPTIONAL
    Description

    If gifting, then the external platform ID of the recipient.

    If using the steam gift_platform, use the 64-bit Steam ID.

  • Name
    gift_platform
    Type
    string?
    Tags
    OPTIONAL
    Description

    The external platform to use with gift_to. Currently only steam is supported.

    Defaults to steam.

  • Name
    gameserver_id
    Type
    string?
    Tags
    OPTIONAL
    Description

    If the product requires a game server selection, the ID of the selected gameserver.

Request

POST
/products/{product.slug}/checkout

Cart

Renders the cart.html template file.

Request

GET
/cart

Add to Cart

Adds an item to the customer's cart.

  • Query Parameters

  • Name
    quantity
    Type
    integer?
    Tags
    OPTIONAL
    Description

    The quantity of the product to add to cart. Defaults to 1.

  • Name
    gameserver_id
    Type
    string?
    Tags
    OPTIONAL
    Description

    If the product requires a game server selection, the ID of the selected gameserver.

Request

POST
/cart/add/{product.slug}

Set Cart Line

Updates a cart line.

  • Query Parameters

  • Name
    quantity
    Type
    integer?
    Tags
    OPTIONAL
    Description

    The quantity of the product to set. Defaults to 1.

  • Name
    gameserver_id
    Type
    string?
    Tags
    OPTIONAL
    Description

    If the product requires a game server selection, the ID of the selected gameserver.

Request

POST
/cart/set/{product.slug}

Remove from Cart

Updates a cart line.

  • Query Parameters

  • Name
    quantity
    Type
    integer?
    Tags
    OPTIONAL
    Description

    The quantity of the product to set. Defaults to 1.

  • Name
    gameserver_id
    Type
    string?
    Tags
    OPTIONAL
    Description

    If the product requires a game server selection, the ID of the selected gameserver.

Request

POST
/cart/set/{product.slug}

Empty Cart

Empties the entire cart.

Request

POST
/cart/empty

Checkout Cart

Creates a checkout session from the cart.

  • Query Parameters

  • Name
    return_url
    Type
    string?
    Tags
    OPTIONAL
    Description

    The URL to return to after a successful checkout. Leave empty to redirect to /complete.

Request

POST
/cart/checkout

Sign In

Signs into the webstore with the preferred authentication platform.

  • Query Parameters

  • Name
    return_url
    Type
    string?
    Tags
    OPTIONAL
    Description

    The URL to return to after a successful checkout.

Request

POST
/auth/sign-in

Sign Out

Signs out from the webstore.

Request

POST
/auth/sign-out

Subscriptions

Renders the subscriptions.html template file.

Request

GET
/subscriptions

Cancel Subscription

Cancels an active subscription by its ID.

We strongly recommend to implement this in your template to increase the trust of your customers, and assure them that there is an easy way to cancel their subscription.

Request

POST
/subscriptions/{subscription.id}/cancel

Complete

Renders the complete.html template file.

Request

GET
/complete

Terms of Service

Redirects to the terms of service of PayNow.

You are required to include a link to this in your template.

Request

GET
/legal/terms-of-service

User Agreement

Redirects to the user agreement of PayNow.

You are required to include a link to this in your template.

Request

GET
/legal/user-agreement

Privacy Policy

Redirects to the privacy policy of PayNow.

You are required to include a link to this in your template.

Request

GET
/legal/privacy-policy