Retrieve account balance

Use getPendingPayout to retrieve a detailed estimation of the amount that 2Checkout owes you, based on the sales from your current payout period.

The amounts returned by this API method are approximations, and may not represent the final amount that 2Checkout will pay you at the end of the billing period.

Request parameters

Parameter	Type / Description
inputParameters	Object (Optional) Details below
inputParameters.Currency	String (Optional) Use this parameter to show the balance only for a single order currency. Example: 'USD'. If not sent, or sent as NULL, 2Checkout sends the balance for all order currencies.
inputParameters.TotalCurrency	String (Optional) Use this parameter to show the total account balance in the preferred currency. Example: 'EUR'. If not sent, or sent as NULL, 2Checkout sends the total balance in the default account currency.

Request sample

<?php

require('PATH_TO_AUTH');

$inputParameters = new StdClass();
$inputParameters->Currency = 'USD';
$inputParameters->TotalCurrency = 'EUR';

$jsonRpcRequest = array(
    'jsonrpc' => '2.0',
    'method' => 'getPendingPayout',
    'params' => array($sessionID, $inputParameters),
    'id' => $i++
);

echo "<pre>";

var_dump("getPendingPayout", callRPC((Object)$jsonRpcRequest, $host));

Response parameters

Pending Payout Object

Parameter	Type / Description
Currencies	Array of objects Details below
Currencies.CurrencyObject	Object Details below
Currencies.CurrencyObject.Currency	String Order currency.
Currencies.CurrencyObject.OrdersTotal	Object Total order amounts, divided per order source.
Currencies.CurrencyObject.OrdersTotal.estore	Float eStore order amounts from the current payout cycle.
Currencies.CurrencyObject.OrdersTotal.affiliates	Float Amounts from your affiliates orders, during the current payout cycle.
Currencies.CurrencyObject.OrdersTotal.partner	Float Amounts from your partner sales, during the current payout cycle.
Currencies.CurrencyObject.OrdersTotal.total	Float Total sales amount made in the order currency from this object, during the current payout cycle.
Currencies.RetainedToDisputesBalance	Float Amounts retained to your dispute balance reports, in the object order currency.
Currencies.ReleasedFromDisputesBalance	Float Amounts released from your dispute balance reports, in the object order currency.
Currencies.RetainedToRollingReserveBalance	Float Amounts retained to your rolling reserve, in the object order currency.
Currencies.ReleasedFromRollingReserveBalance	Float Amounts retained to your rolling reserve, in the object order currency
Currencies.ChargebackFees	Float Chargeback fees retained in the object order currency.
Currencies.ProcessingFees	Float Processing fees retained by 2Checkout in the object order currency.
Currencies.AffiliatesCommission	Float Affiliate commissions paid by 2Checkout in the object order currency.
Currencies.TaxCollected	Float Tax collected by 2Checkout in the object order currency.
Currencies.EstimatedTotalRevenue	Float The estimated total revenue for the object order currency.
Total	Object Total account balance amount
Total.Currency	String Currency used for expressing the account balance.. If not sent in the API call, 2Checkout uses the account default currency.
Total.OrdersTotal	Object Total order amounts, divided per order source.
Total.OrdersTotal.estore	Float Amounts from total eStore orders during the currency payout cycle.
Total.OrdersTotal.affiliates	Float Amounts from total affiliates orders during the currency payout cycle.
Total.OrdersTotal.partner	Float Amounts from total partner orders during the currency payout cycle.
Total.OrdersTotal.total	Float Total sales amount during the currency payout cycle.
Total.RetainedToDisputesBalance	Float Total amounts retained to your dispute balance during the current payout cycle.
Total.RetainedFromDisputesBalance	Float Total amounts released from your dispute balance during the current payout cycle.
Total.RetainedToRollingReserveBalance	Float Total amounts retained to your rolling reserve during the current payout cycle.
Total.RetainedFromRollingReserveBalance	Float Total amounts released from your rolling reserve during the current payout cycle.
Total.ChargebackFees	Float Total chargeback fees retained from your account during the currency payout cycle.
Total.ProcessingFees	Float Total processing fees retained by 2Checkout during the current payout cycle.
Total.AffiliatesCommission	Float Total affiliates commissions paid by 2Checkout during the current payout cycle.
Total.TaxCollected	Float Total tax amount collected by 2Checkout during the current payout cycle.
Total.EstimatedTotalRevenue	Float Total estimated revenue for the current payout cycle.