GET /payments/balances

Updated on

Retrieves all balanceItems related to the user. See balanceItem element definition in WSDL/XSD.

This resource requires connectid, nonce, date and signature for authentication. See Authentication documentation for REST and SOAP. Passing authentication information as query parameters for REST is supported.

Resource URL

XML: https://api.zanox.com/xml/2011-03-01/payments/balances
JSON: https://api.zanox.com/json/2011-03-01/payments/balances

Parameters

items optional	number of items in the result set [1..n] Value Type: integer Example Values: `1` (default = 10; maximum = 50)
page / total optional / not supported 08/2014 (values set to 0, because paging is not supported anymore / needed.	page position [0..n] Value Type: integer Example Values: `1` (default: 0)
callback optional	Supported if format is JSON. Returns the name of the JS function the result is wrapped in. Value Type: String Example Values:
credited	currently not supported

Example Request

REST authentication information must be included in request headers or added as query parameters

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://api.zanox.com/namespace/2011-03-01/">
    <page>0</page>
    <items>2</items>
    <total>0</total>
    <balanceItems>
        <balanceItem id="EUR">
            <open>150.00</open>
            <confirmed>50.00</confirmed>
        </balanceItem>
        <balanceItem id="USD">
            <open>20.00</open>
            <confirmed>10.00</confirmed>
        </balanceItem>
    </balanceItems>
</response>

Resource Information

Rate Limited?	No
Authentication	Requires signature. See REST Authentication SOAP Authentication
Response Formats	json, xml
HTTP Methods	GET
Resource family	Balances
Response Object	balanceItems
API Version	2011-03-01