Реестры успешных и возвращенных выплат
ЮKassa ежедневно формирует реестры успешных и возвращенных выплат. В реестрах — все операции за указанную дату (в период с 00:00:00 по 23:59:59 по московскому времени):
  • в реестре успешных выплат — все зачисленные выплаты;
  • в реестре возвращенных выплат — все возвращенные (полностью и частично) выплаты.
Реестры приходят на электронную почту, которую вы сообщили менеджеру при подключении. Реестры успешных и возвращенных выплат приходят разными письмами.
Если за указанную дату не было совершено никаких операций, придет пустой реестр.
 
Формат письма
Письма подписываются сертификатом ЮKassa (S/MIME подпись).
Тема электронного письма формируется по шаблону (нумерация сквозная):
РЕЕСТР ДЛЯ <Ваше название в ЮKassa> ЗА <дата выплат в формате ДД-ММ-ГГГГ>. №<номер>
Во вложении к письму реестр в двух файлах:
Формат имени файла реестра успешных выплат
settlement_file_<agentId>_<yyyy-mm-dd>_<номер>.csv

settlement_file_<agentId>_<yyyy-mm-dd>_<номер>.xls
Формат имени файла реестра возвращенных выплат
refund_<agentId>_<yyyy-mm-dd>_<номер>.csv

refund_<agentId>_<yyyy-mm-dd>_<номер>.xls
 
Структура реестра
Реестр содержит:
  • заголовок с номером и датой реестра;
  • перечень зачисленных или возвращенных выплат;
  • сводную информацию по выплатам, включая баланс обеспечительного счета.
 
Реестр в формате CSV
Формат файла реестра соответствует рекомендации IETF RFC4180. Разделитель полей — точка с запятой «;». Кодировка символов — UTF‑8.
Текстовый формат CSV представляет собой набор строк, разделенных символом переноса строки (LF или CRLF). Каждая строка содержит поля, разделенные точкой с запятой «;». Если в значении параметра встречаются символы двойные кавычки «"», точки с запятой «;» или переносы строк, то такие параметры должны заключаться в кавычки «"».
Допустимо помещать в кавычки все поля, вне зависимости от присутствующего в них набора символов. Если поле не помещено в кавычки, то все «соседние» пробелы (до точек с запятой или до начала или конца строки) игнорируются.
 
Структура
Содержимое файла реестра состоит из следующих элементов:
  • HD-строка — заголовок реестра;
  • D-строки — информация о выплатах;
  • TD-строка — контрольная строка, сумма всех выплат за указанный период;
  • Z-строка
     — маркер отсутствия выплат (присутствует, если за указанный период не было никаких операций).
 
Заголовок (HD-строка)
Заголовок реестра содержит идентификатор магазина в ЮKassa, номер реестра (идентификатор реестра) и отчетный период, за который сформирован реестр.
 
Формат заголовка реестра
HD;registerId;agentId;from;till
 
Параметры заголовка реестра
ПараметрТипОписание
registerIdxs:longИдентификатор сформированного реестра, уникальный на протяжении всей истории операций.
agentIdxs:longИдентификатор вашего шлюза в ЮKassa.
fromxs:dateTime
Начало отчетного периода, за который сформирован реестр, включительно («от» включая).
Дата и время в формате
ГГГГ-ММ-ДДТчч:мм:сс.ссс±чч:мм
(ISO 8601).
tillxs:dateTime
Конец отчетного периода, за который сформирован реестр, исключительно («до» не включая).
Дата и время в формате
ГГГГ-ММ-ДДТчч:мм:сс.ссс±чч:мм
(ISO 8601).
 
Пример заголовка реестра
HD;123456;2277;2015-07-01T00:00:00.000+03:00;2015-07-02T00:00:00.000+03:00
 
Информация о выплате (D-строка)
Для каждой операции, проведенной за отчетный период, формируется отдельная D-строка.
 
Формат строки с информацией о выплате
D;clientOrderId;amount;currency;dstAccount;processedDT;comission;comissionCurrencyCode
 
Параметры строки с информацией о выплате
ПараметрТипОписание
dstAccountYMAccountИдентификатор получателя перевода, значение параметра
dstAccount
из запроса makeDeposition.
clientOrderIdClientTransactionNumberУникальный номер транзакции в ЮKassa (string, до 32 символов). Значение параметра
clientOrderId
из запроса makeDeposition.
processedDTxs:dateTime
Время зачисления на счет получателя, приходит в ответе на makeDeposition. В случае возврата — время проведения операции возврата денег со счета получателя выплаты.
Дата и время по часам ЮKassa в формате
ГГГГ-ММ-ДДТчч:мм:сс.ссс±чч:мм
(ISO 8601).
amountCurrencyAmountСумма выплаты или возврата. Разделитель дробной части — запятая, всегда ровно два знака после запятой, разделитель тысяч отсутствует. Значение
amount
из запроса makeDeposition.
currencyCurrencyCodeКод валюты транзакции — целое беззнаковое число. Например:
643
 — рубль РФ.
comissionCurrencyAmount
Сумма комиссии, которую ЮKassa списала за проведение выплаты. Разделитель дробной части — запятая, всегда ровно два знака после запятой, разделитель тысяч отсутствует.
Может отсутствовать, если вы подключились до августа 2019 г. Чтобы получать в реестрах информацию о комиссиях, напишите вашему менеджеру.
comissionCurrencyCurrencyCodeКод валюты комиссии — целое беззнаковое число. Например:
643
 — рубль РФ.
 
Пример строки
D;123;107.00;643;410010000400;2015-07-01T10:52:01.000+03:00;3.21;643
 
Контрольная строка (TD-строка)
Контрольная строка представляет собой сумму всех переводов по текущему реестру. Если переводов в указанный период не было, то реестр считается пустым и контрольная строка отсутствует.
Пустой реестр содержит только строку заголовка и нулевую строку (Z-строку).
 
Формат строки
TD;count;sum;currency;comissionSum;comissionCurrency
 
Параметры контрольной строки
ПараметрТипОписание
countxs:intКоличество выплат за указанный период.
sumCurrencyAmountОбщая сумма выплат за указанный период.
currencyCurrencyCodeКод валюты общей суммы.
comissionSumCurrencyAmountОбщая сумма комиссии за указанный период.
comissionCurrencyCurrencyCodeКод валюты общей суммы комиссии.
 
Пример строки
TD;86;88230.95;643;1163.25;643
 
Примеры реестров в формате CSV
Пример реестра
HD;123456;2277;2019-07-08T00:00:00.000+03:00;2019-07-09T00:00:00.000+03:00
D;123;107.00;643;41001000040;2019-07-08T08:49:48.648+03:00;3.21;643
D;124;200.00;643;41001000040;2019-07-08T10:37:39.974+03:00;6.00;643
TD;2;307.95;643;9.21;643
Пример пустого реестра
HD;123456;2277;2015-07-01T00:00:00.000+03:00;2015-07-02T00:00:00.000+03:00
Z
Примеры файлов
Пример реестра успешных выплат: settlement_file_123456_08.07.2019_2000013203127.csv
Пример реестра возвращенных выплат: refund_123456_08.07.2019_2000013203129.csv
Пример пустого реестра: settlement_file_123456_08.07.2019_2000013203128.csv
 
Реестр в формате XLS
 
Поля реестра
ПолеЗначение
Заголовок
AGENT IDИдентификатор вашего шлюза в ЮKassa.
Дата
Дата в формате
ДД.ММ.ГГГГ
В реестр попадают платежи, датированные этим числом.
Порядковый номер реестра.
Таблица
Номер транзакцииУникальный номер транзакции в ЮKassa (string, до 32 символов). Значение параметра
clientOrderId
из запроса makeDeposition.
СуммаСумма транзакции. Разделитель дробной части — запятая, всегда ровно два знака после запятой, разделитель тысяч отсутствует. Значение
amount
из запроса makeDeposition.
ВалютаВалюта транзакции. Трехбуквенный код, например:
RUB
 — рубль РФ.
Идентификатор получателяИдентификатор получателя перевода, значение параметра
dstAccount
из запроса makeDeposition.
Дополнительные реквизиты
Одно из трех значений, зависит от назначения выплаты.
На банковский счет: номер банковского счета получателя.
На баланс мобильного:
  • PROPERTY1
     — код оператора мобильной связи;
  • PROPERTY2
     — номер телефона.
PROPERTY1
и 
PROPERTY
передаются в склеенном виде. Присутствуют, если были переданы в запросе makeDeposition.
ФИО получателя
Данные получателя перевода из запроса makeDeposition:
  • pdr_lastName
     — фамилия;
  • pdr_firstName
     — имя;
  • pdr_middleName
     — отчество.
Передаются в склеенном виде, только для выплат на банковские карты или счет.
Время перевода
Время зачисления на счет получателя, приходит в ответе на makeDeposition. В случае возврата — время проведения операции возврата денег со счета получателя выплаты.
Дата и время по часам ЮKassa в формате
ГГГГ-ММ-ДДТчч:мм:сс.ссс±чч:мм
(ISO 8601).
Назначение
Счет, на который зачисляются деньги. Варианты:
  • Кошелек ЮMoney;
  • Банковская карта;
  • Банковский счет;
  • Баланс мобильного телефона.
Комиссия
Сумма комиссии, которую ЮKassa списала за проведение выплаты. Разделитель дробной части — запятая, всегда ровно два знака после запятой, разделитель тысяч отсутствует.
Может отсутствовать, если вы подключились до августа 2019 г. Чтобы получать в реестрах информацию о комиссиях, напишите вашему менеджеру.
Валюта комиссииТрехбуквенный код, например:
RUB
 — рубль РФ.
Контрольная строка
Баланс счетаСумма обеспечения баланса выплат на момент формирования реестра.
 
Что почитать еще
Зачисление переводов