Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Customer Management

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Balances

Manage and view balances for your Sub Resellers

Get your free API Key

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/account/balance

    Gets the current balance on your account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : {
            "balance" : 10.0
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/account/reseller/{uuid}/balance

    Gets the balance for the specified sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller whose balance is to be queried

    Response Details

    200 Response

    {
        "result" : {
            "balance" : 10.0
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/account/reseller/{uuid}/balance/history

    Gets the historical balance for a sub reseller

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller whose balance history should be queried

    Response Details

    200 Response

    {
        "result" : [
            {
                "balance" : 20.0,
                "created_on" : "2017-02-24"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • Chargeable *

    PUT/account/reseller/{uuid}/balance?net={net}

    Allocates credit from the master reseller to the target reseller

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Sub Reseller who is the target of the balance re-allocation

      • net

      • String

      • True

      Should this transfer have VAT added by the API, or is it already calculated?

    PUT body

    • Name

    • Type

    • Required

      • balance

      • String

      • True

      The balance to be transferred in GBP

    JSON all-fields example:

    {
        "balance" : "10.00"
    }

    Response Details

    200 Response

    {
        "result" : {
            "balance" : 10.0
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    402 Response

    {
        "result" : {},
        "status_code" : 402,
        "status_message" : "Payment Required"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
View Desktop Site