Вернуться к списку методов...

Метод getTotalBalance

Получение общей информации о балансах пользователя по всем доступным эмиссиям (Stealth-чеком)

https://paymer.com/ci/webapi/get_total_balance

• запрос:

Метод не требует параметров в теле запроса. Данные определяются по идентификатору пользователя из JWT-токена (userIdClaim.Value).

• ответ:

<TotalBalancesResponse>
    <RetCode>int</RetCode>
    <ErrorMessage>string</ErrorMessage>
    <Issues>
        <IssueParms>
            <CoreIssueId>int</CoreIssueId>
            <Blockchain>string</Blockchain>
            <Balance>decimal</Balance>
            <AmlStatus>int</AmlStatus>
            <OrdersSummary>
                <OrderSummary>
                    <Amount>decimal</Amount>
                    <Balance>decimal</Balance>
                </OrderSummary>
                ...
            </OrdersSummary>
        </IssueParms>
        ...
    </Issues>
</TotalBalancesResponse>

• параметры ответа:

название	назначение	примечание
Issues	массив структур с данными по каждой эмиссии, доступной пользователю	может быть пустым, если у пользователя нет балансов
RetCode	код возврата	описание внизу страницы
ErrorMessage	текстовое описание в случае ошибки

Структура IssueParms (элемент массива Issues)

название	назначение	примечание
CoreIssueId	Id выпуска в ядре Paymer
Blockchain	блокчейн эмиссии	AVAX BSC ETH TRX
Balance	общий доступный баланс по эмиссии	сумма балансов всех ордеров
AmlStatus	статус AML-проверки эмиссии	значение из перечисления ComplianceStatus
OrdersSummary	массив сводных данных по ордерам в рамках эмиссии	может быть пустым

Структура OrderSummary (элемент массива OrdersSummary)

название	назначение	примечание
Amount	номинальная сумма чека Paymer
Balance	текущий доступный баланс чека Paymer

• коды возврата:

код	название	описание
0	Success	Данные успешно возвращены
7	NotFound	Балансы (чеки) для пользователя не найдены
10	AccessDenied	Неверные или отсутствующие данные аутентификации (apiKeyId/apiKeyValue или JWT-токен)