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