GET /payments/balance/{currency}

Updated on
 
Retrieves a single balanceItem.  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/balance/{id}
JSON: https://api.zanox.com/json/2011-03-01/payments/balance/{id}

Parameters

currency
required

to constrain the user balances for the given currency.

Value Type: Please abide by the ISO 4217 syntax.
Example Values Avaliable currencies

callback
optional

Supported if format is JSON. Returns the name of the JS function the result is wrapped in.

Value Type: String
Example Values 

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/">
    <balanceItem id="EUR">
        <open>150.00</open>
        <confirmed>50.00</confirmed>
    </balanceItem>
</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 balanceItem
API Version 2011-03-01