Current Balance (API)

You can find out the amount of balance on your account available for payment via API. The server response displays information about the netting balance available for payment.

https://unitpay.ru/api?
     method=getPartner 
     params[login][email protected] 
     params[secretKey]=key

login

string

E-mail account in the UnitPay system

secretKey

string

The account's secret key, available in the profile settings

Example of a successful response:

{
    "result": {
        "email": "[email protected]",
        "accounts": {
            "rub": {
                "balance": "1060.76",
                "availableBalance": "1060.76"
            },
        }
    }
}

email

e-mail

E-mail аккаунта в системе UnitPay

balance

number

Total account balance

availableBalance

number

Account balance available for withdrawal

Ошибочный ответ

{"error": {
    "message": "Incorrect authorization parameters",
    "code": -32000
}}

-32000

Incorrect authorization parameters (login, secret key)

-32602

Incorrect query parameters

-32603

Internal technical error

Some of the balance may not be available for payout for some time, depending on the hold.

Types of Holds:

  1. Static Hold - a certain amount is held on your balance, which you cannot withdraw until the hold is lifted.

  2. Dynamic hold - hold for days. All received funds from your clients are blocked for a certain number of days, after which you will be able to withdraw funds. For example, if the dynamic hold is set for 3 days, the funds received on Monday will be available for withdrawal on Thursday. The funds received on Tuesday will be available for withdrawal on Friday, etc.

  3. Hold on payments - similar to "Statistical Hold", but within specific payments.

Last updated

Was this helpful?