Операция get_batch_info
Операция получения подробной информации по загруженному документу массового платежа (по батчу).
Параметры запроса
| Параметр | Значение |
|---|---|
| operation | get_batch_info |
| login | <Имя пользователя> |
| token | <TOKEN>. Получен при вызове get_token. |
| encrypted_password | Зашифрованный пароль. Получен в результате RSA шифрования пароля пользователя при помощи публичной экспоненты и модуля, полученных при вызове операции get_token. |
| batch_id | <id платежа>. Идентификатор документа на платеж, полученный вызовом import_batch_advanced. |
| page_size | Количество записей для получения. |
| start_offset | Номер записи, начиная с которой выдавать результирующий набор. Минимум – 0, максимум – количество записей в этом документе массового платежа. Вместо него можно использовать параметр page — Номер страницы (начиная с 0). |
Смотрите также
- import_batch_advanced — Загрузка массового платежа (батча) в систему с возможностью выбора способа подтверждения.
Ответ
Значения
| Значение | Описание |
|---|---|
| <id платежа> | Идентификатор созданного в системе массового документа на платеж |
| <offset> | Номер записи, начиная с которой сформирован результирующий набор (начиная с 0) |
| <page_size> | Количество записей для получения |
| <total_size> | Общее количество записей в батче |
| <page_count> | Количество страниц |
| <current_page> | Номер текущей страницы (нумерация с 0) |
| <статус документа> | Может принимать следующие значения:
|
| <тип платежа> | Может принимать значение SKIP в случае, если документ был отклонен на стадии загрузки (import_batch_advanced) массового платежа (подробности см. в <описание ошибки>) |
| <описание ошибки> | Описание причины отклонения документа |
Примеры ответов
JSON (рекомендуемый, установите x-response-format=json)
{
"code": 0,
"message": "",
"data": {
"id": "c1f56606-15a8-43ff-99ef-a2a63ddc819a",
"offset": 0,
"page": 0,
"pageSize": 100,
"pageCount": 1,
"totalCount": 9,
"records": [
{
"lineNumber": 1,
"internalNumber": "1003",
"beneficiary": "Z112224443331",
"amount": "1.10",
"currency": "USD",
"description": "Payout 3",
"documentId": 92362495,
"state": "PROCESSED",
"paymentType": "WM",
"errorDetails": "",
"txId": null
},
{
"lineNumber": 2,
"internalNumber": "1004",
"beneficiary": "Z112224443331",
"amount": "1.20",
"currency": "USD",
"description": "Payout 4",
"documentId": 92362517,
"state": "DECLINED",
"paymentType": "WM",
"errorDetails": "",
"txId": null
},
{
"lineNumber": 3,
"internalNumber": "1005",
"beneficiary": "Z112224443331",
"amount": "1.30",
"currency": "USD",
"description": "Payout 5",
"documentId": 92362539,
"state": "PROCESSED",
"paymentType": "WM",
"errorDetails": "",
"txId": null
},
{
"lineNumber": 4,
"internalNumber": "1006",
"beneficiary": "Z112224443331",
"amount": "1.40",
"currency": "USD",
"description": "Payout 6",
"documentId": 92362561,
"state": "PROCESSED",
"paymentType": "WM",
"errorDetails": "",
"txId": null
},
{
"lineNumber": 5,
"internalNumber": "1007",
"beneficiary": "Z112224443331",
"amount": "1.50",
"currency": "USD",
"description": "Payout 7",
"documentId": 92362583,
"state": "PROCESSED",
"paymentType": "WM",
"errorDetails": "",
"txId": null
},
{
"lineNumber": 6,
"internalNumber": "1008",
"beneficiary": "R555511198765",
"amount": "1.10",
"currency": "RUR",
"description": "Payout 8",
"documentId": 92362605,
"state": "PROCESSED",
"paymentType": "WM",
"errorDetails": "",
"txId": null
},
{
"lineNumber": 7,
"internalNumber": "1009",
"beneficiary": "R555511198765",
"amount": "1.20",
"currency": "RUR",
"description": "Payout 9",
"documentId": 92362627,
"state": "PROCESSED",
"paymentType": "WM",
"errorDetails": "",
"txId": null
}
]
}
}