Search documents by number from your system.
Query parameters
| Parameter | Value |
|---|
| operation | documents_search |
| login | <Username> |
| token | <TOKEN>. Obtained after invoking get_token. |
| encrypted_password | Encrypted password. It is obtained after user password RSA encryption with the use of a public exponent and the modulus obtained in invoking the get_token operation. |
| beginDate | Period starting date. |
| endDate | Period ending date. |
| customNumber | Payment number from your system. Необязательный параметр. |
See also
Response in the CSV format
Format
| Line No. | Data format |
|---|
| 1 | 0 |
| 2, 3, ..., n | <type>;<batchId>;<timestamp>;<sourceAccount>;<destinationAccount>;<amount>;<currency> ;<description>;<customNumber>;<documentNumber>;<comment>;<documentState>;<localizedDocumentState> |
Values
| Value | Description |
|---|
| <type> | Type of the payment (Opcode of mass payment) |
| <batchId> | The ID of the batch payment document created in the system |
| <timestamp> | Document creation date (timestamp) |
| <sourceAccount> | Source account |
| <destinationAccount> | Destination account |
| <amount> | Amount |
| <currency> | Currency |
| <description> | Payment description |
| <customNumber> | Payment number from your system |
| <documentNumber> | Capitalist payment number |
| <comment> | Description of the reason for rejecting the document |
| <documentState> | It may take the following values: - NEW, READY — awaiting processing
- INPROCESS — in process
- DECLINED — declined
- PROCESSED — processed
|
| <localizedDocumentState> | Localized document state |
Response examples
JSON (recommended format, please set x-response-format=json header)
{
"code": 0,
"message": "",
"data": {
"search": {
"beginDate": "04.06.2016",
"endDate": "04.07.2016",
"customNumber": null
},
"documents": [
{
"type": "CAPITALIST",
"sourceAccount": "R0100813",
"destinationAccount": "R0100271",
"batchId": "344bfcc6-1231-4eb1-a8bd-872c1f697bb0",
"timestamp": 1465483189,
"currency": "RUR",
"amount": "12.34",
"description": "Payout CAP",
"customNumber": "9666",
"documentNumber": null,
"comment": null,
"documentState": "INPROCESS",
"localizedDocumentState": "В обработке"
},
{
"type": "BANKCARD",
"sourceAccount": "R0100813",
"destinationAccount": "5187 7429 3333 1234",
"batchId": "344bfcc6-1231-4eb1-a8bd-872c1f697bb0",
"timestamp": 1465483189,
"currency": "RUR",
"amount": "100.00",
"description": null,
"customNumber": "9999",
"documentNumber": null,
"comment": "Неверно задано значение поля Card number",
"documentState": "DECLINED",
"localizedDocumentState": "Отменен"
},
{
"type": "CAPITALIST",
"sourceAccount": "R0100671",
"destinationAccount": "R0100271",
"batchId": "6d04b343-434e-40af-a225-67d1bd0294b7",
"timestamp": 1465483189,
"currency": "RUR",
"amount": "10.00",
"description": "Payout",
"customNumber": "9999",
"documentNumber": "93173750",
"comment": null,
"documentState": "PROCESSED",
"localizedDocumentState": "Обработан"
},
{
"type": "QIWI",
"sourceAccount": "R0100671",
"destinationAccount": "9030120099",
"batchId": "3668010f-d074-4bc1-9d28-732c8ab18240",
"timestamp": 1465483189,
"currency": "RUR",
"amount": "100.00",
"description": null,
"customNumber": "1001",
"documentNumber": null,
"comment": null,
"documentState": "INPROCESS",
"localizedDocumentState": "В обработке"
}
]
}
}
CSV
0;;04.06.2016;04.07.2016;
CAPITALIST;344bfcc6-1231-4eb1-a8bd-872c1f697bb0;1465483189;R0100813;R0100271;12.34;RUR;"Payout CAP";9666;;;INPROCESS;"В обработке"
BANKCARD;344bfcc6-1231-4eb1-a8bd-872c1f697bb0;1465483189;R0100813;"5187 7429 3333 1234";100.00;RUR;;9999;;"Неверно задано значение поля Card number";DECLINED;Отменен
CAPITALIST;6d04b343-434e-40af-a225-67d1bd0294b7;1465483189;R0100671;R0100271;10.00;RUR;Payout;9999;93173750;;PROCESSED;Обработан
QIWI;3668010f-d074-4bc1-9d28-732c8ab18240;1465483189;R0100671;9030120099;100.00;RUR;;1001;;;INPROCESS;"В обработке"