{"openapi":"3.0.0","servers":[{"url":"https://ibapi.alfabank.by:8273/partner/1.34.0/acquiring"},{"url":"http://ibapi.alfabank.by:8273/partner/1.34.0/acquiring"}],"info":{"version":"1.34.0","title":"partner.acquiring","description":"API сервиса Эквайринг."},"tags":[{"name":"acquiring","description":"API сервиса Эквайринг."}],"security":[{"BearerAuth":[]}],"paths":{"/version":{"get":{"tags":["acquiring"],"security":[],"operationId":"versionGet","summary":"Получить версию API.","description":"Получить версию API.","x-auth-type":"None","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}}},"x-st-position":1,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/version\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/version\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/version\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/version')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-throttling-tier":"Unlimited"}},"/accounts":{"get":{"tags":["acquiring"],"summary":"Получить список счетов пользователя.","description":"Получить список счетов пользователя по заданным критериям.\nВ список попадают счета, обслуживаемые в Альфабанке.\n","operationId":"getAccounts","x-scope":"read_acquiring_partner","parameters":[{"in":"query","name":"criteria","schema":{"$ref":"#/components/schemas/AccountCriteria"},"description":"Критерий выборки счетов.","required":true}],"responses":{"200":{"description":"Счета, обслуживаемые в Альфабанке, связанные с терминалами.\nСортировка Account.number ASC.\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":2,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/accounts?criteria=PAYMENT\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/accounts?criteria=PAYMENT\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/accounts?criteria=PAYMENT\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/accounts?criteria=PAYMENT')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/terminals":{"get":{"tags":["acquiring"],"summary":"Получить список терминалов.","description":"Получить список терминалов по заданным критериям.","operationId":"getTerminals","x-scope":"read_acquiring_partner","parameters":[{"in":"query","name":"criteria","schema":{"$ref":"#/components/schemas/TerminalCriteria"},"style":"form","explode":true,"example":"account=BY99BETA30111512345678000000"}],"responses":{"200":{"description":"Список терминалов.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Terminal"}}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":3,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals?account=BY99ALFA30151512345678000001\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals?account=BY99ALFA30151512345678000001\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals?account=BY99ALFA30151512345678000001\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals?account=BY99ALFA30151512345678000001')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/terminals/{terminalId}":{"get":{"tags":["acquiring"],"summary":"Получить терминал по идентификатору.","description":"Получить терминал по идентификатору.","operationId":"getTerminalById","x-scope":"read_acquiring_partner","parameters":[{"in":"path","name":"terminalId","schema":{"type":"string"},"required":true,"description":"Идентификатор терминала."}],"responses":{"200":{"description":"Терминал.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Terminal"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":4,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/terminals/{terminalId}/limits":{"get":{"tags":["acquiring"],"summary":"Получить список лимитов по идентификатору терминала.","description":"Получить список лимитов по идентификатору терминала.\n\nЛимиты - ограничения накладываемые на терминал. (См. TerminalLimit).\nЛимиты по регионам отсортированы в алфавитном порядке по наименованию региона.\n","operationId":"getTerminalLimits","x-scope":"read_acquiring_partner","parameters":[{"in":"path","name":"terminalId","schema":{"type":"string"},"required":true,"description":"Идентификатор терминала."}],"responses":{"200":{"description":"Список лимитов для терминала.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TerminalLimit"}}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":5,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003/limits\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003/limits\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003/limits\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/1adac532-7eb9-4320-bdba-000000000003/limits')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/terminals/limits/batch":{"post":{"tags":["acquiring"],"summary":"Получить лимиты для нескольких терминалов","description":"Возвращает лимиты для списка терминалов в формате:\n{\n  \"terminalLimitsMap\": {\n    \"id-1\": [список лимитов],\n    \"id-2\": [список лимитов]\n  }\n}\n","operationId":"getBatchTerminalLimits","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalLimitsBatchRequest"},"example":{"terminalIds":["id-1","id-2","id-3"]}}}},"responses":{"200":{"description":"Объект с маппингом идентификаторов терминалов на списки лимитов для проведения операций.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalLimitsBatchResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":6,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/terminals/limits":{"get":{"tags":["acquiring"],"summary":"Получить список базовых лимитов для заданного типа Эквайринга.","description":"Получить список базовых лимитов, устанавливаемых на новые терминалы при подключении Эквайринга.\n\nЛимиты - ограничения накладываемые на терминал. (См. TerminalLimit).\nЛимиты по регионам отсортированы в алфавитном порядке по наименованию региона.\n","operationId":"getTerminalLimitsByAcquiringType","x-scope":"read_acquiring_partner","parameters":[{"in":"query","name":"acquiringType","required":true,"description":"Тип Эквайринга.","schema":{"$ref":"#/components/schemas/AcquiringType"}}],"responses":{"200":{"description":"Список базовых лимитов, устанавливаемых на новые терминалы.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TerminalLimit"}}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":7,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/limits?acquiringType=INTERNET\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/limits?acquiringType=INTERNET\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/limits?acquiringType=INTERNET\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/terminals/limits?acquiringType=INTERNET')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/terminals/groups":{"get":{"tags":["acquiring"],"summary":"Получить список групп для терминалов.","description":"Получить список групп для терминалов (см. TerminalGroup).","operationId":"getTerminalGroups","x-scope":"read_acquiring_partner","responses":{"200":{"description":"Список групп для терминалов.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TerminalGroup"}}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":8,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement":{"get":{"tags":["acquiring"],"summary":"Получить выписку.","description":"Получить выписку по заданным критериям.","operationId":"getStatement","x-scope":"read_acquiring_partner","parameters":[{"$ref":"#/components/parameters/StatementCriteriaParameter"},{"$ref":"#/components/parameters/PageParameter"},{"$ref":"#/components/parameters/TransactionSortParameter"}],"responses":{"200":{"description":"Выписка.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Statement"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":9,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement?account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&offset=0&count=20&properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement?account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&offset=0&count=20&properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement?account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&offset=0&count=20&properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement?account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&offset=0&count=20&properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]},"post":{"tags":["acquiring"],"summary":"Получить выписку.","description":"Получить выписку по заданным критериям.","operationId":"getStatementV2","x-scope":"read_acquiring_partner","parameters":[{"$ref":"#/components/parameters/PageParameter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementRequest"}}}},"responses":{"200":{"description":"Выписка.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Statement"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":10,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/report":{"get":{"tags":["acquiring"],"summary":"Получить печатную форму выписки.","description":"Получить печатную форму выписки.","operationId":"getStatementReport","x-scope":"read_acquiring_partner","parameters":[{"$ref":"#/components/parameters/StatementCriteriaParameter"},{"$ref":"#/components/parameters/TransactionSortParameter"},{"in":"query","name":"settings","required":true,"description":"Настройки печатной формы выписки.","schema":{"$ref":"#/components/schemas/StatementReportSettings"}}],"responses":{"200":{"description":"Выписка.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}},"text/plain":{"schema":{"type":"string"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":11,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/report?properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC&account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&format=PDF&summary=true&orientation=LANDSCAPE\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/report?properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC&account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&format=PDF&summary=true&orientation=LANDSCAPE\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/report?properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC&account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&format=PDF&summary=true&orientation=LANDSCAPE\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/report?properties[0].property=CREATE_TIMESTAMP&properties[0].order=DESC&account=BY99ALFA30130000015999706777&tids[0]=K1290011&tids[1]=T2704334&tids[2]=K1290015&types[0]=CANCEL&types[1]=CREDIT&types[2]=REFUND&dateRangeProperty=CREATE&dateRange.name=MONTH&format=PDF&summary=true&orientation=LANDSCAPE')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]},"post":{"tags":["acquiring"],"summary":"Получить печатную форму выписки.","description":"Получить печатную форму выписки.","operationId":"getStatementReportV2","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementRequest"}}}},"responses":{"200":{"description":"Выписка.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}},"text/plain":{"schema":{"type":"string"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":12,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/report/group":{"get":{"tags":["acquiring"],"summary":"Получить печатную форму выписки для группы терминалов.","description":"Получить печатную форму выписки для группы терминалов.","operationId":"getStatementReportGroup","x-scope":"read_acquiring_partner","parameters":[{"$ref":"#/components/parameters/StatementCriteriaParameter"},{"$ref":"#/components/parameters/TransactionSortParameter"},{"in":"query","name":"settings","required":true,"description":"Настройки печатной формы выписки.","schema":{"$ref":"#/components/schemas/StatementReportSettings"}}],"responses":{"200":{"description":"Выписка.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}},"text/plain":{"schema":{"type":"string"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":13,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]},"post":{"tags":["acquiring"],"summary":"Получить печатную форму выписки для группы терминалов.","description":"Получить печатную форму выписки для группы терминалов.","operationId":"getStatementReportGroupV2","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementRequest"}}}},"responses":{"200":{"description":"Выписка.","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}},"text/plain":{"schema":{"type":"string"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":14,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/schedule":{"post":{"tags":["acquiring"],"summary":"Создать расписание отправки выписки на email.","description":"Создать расписание отправки выписки на email.","operationId":"createStatementSchedule","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStatementScheduleRequest"}}}},"responses":{"200":{"description":"Объект расписания.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedStatementScheduleResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":15,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]},"get":{"tags":["acquiring"],"summary":"Получение всех расписаний отправки выписки на email для пользователя.","description":"Получить расписания отправки выписки на email для пользователя.","operationId":"getStatementSchedules","x-scope":"read_acquiring_partner","parameters":[{"$ref":"#/components/parameters/PageParameter"}],"responses":{"200":{"description":"массив объектов расписания.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementSchedulesResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":16,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]},"delete":{"tags":["acquiring"],"summary":"Получение расписания отправки выписки на email для пользователя.","description":"Получить расписание отправки выписки на email для пользователя.","operationId":"deleteStatementSchedule","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteStatementScheduleRequest"}}}},"responses":{"200":{"description":"Ok."},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":17,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]},"put":{"tags":["acquiring"],"summary":"изменение полей расписания отправки выписок","description":"изменение полей расписания отправки выписок","operationId":"updateStatementSchedule","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStatementScheduleRequest"}}}},"responses":{"200":{"description":"массив объектов расписания.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedStatementScheduleResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":18,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/schedule/{id}":{"get":{"tags":["acquiring"],"summary":"Получение расписания отправки выписки на email для пользователя.","description":"Получить расписание отправки выписки на email для пользователя.","operationId":"getStatementSchedule","x-scope":"read_acquiring_partner","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Идентификатор расписания."}],"responses":{"200":{"description":"массив объектов расписания.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedStatementScheduleResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":19,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/emails":{"post":{"tags":["acquiring"],"summary":"Отправить выписку на email.","description":"Отправить выписку на email.","operationId":"sendStatementByEmail","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementEmailRequest"}}}},"responses":{"200":{"description":"Ok."},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":20,"x-st-code-samples":[{"lang":"curl","sample":"curl -X POST \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  -H 'Content-type: application/json' \\\n  --data-raw \"{\\\"sort\\\":{\\\"properties\\\":[{\\\"property\\\":\\\"CREATE_TIMESTAMP\\\",\\\"order\\\":\\\"DESC\\\"}]},\\\"criteria\\\":{\\\"account\\\":\\\"BY99ALFA30130000015999706777\\\",\\\"tids\\\":[\\\"T1290011\\\",\\\"T2704334\\\",\\\"T1290015\\\"],\\\"types\\\":[\\\"CANCEL\\\",\\\"CREDIT\\\",\\\"REFUND\\\"],\\\"dateRangeProperty\\\":\\\"CREATE\\\",\\\"dateRange\\\":{\\\"name\\\":\\\"MONTH\\\",\\\"range\\\":null}},\\\"settings\\\":{\\\"format\\\":\\\"PDF\\\",\\\"summary\\\":true,\\\"orientation\\\":\\\"LANDSCAPE\\\"},\\\"recipients\\\":[\\\"user@foobar.com\\\"]}\" \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/emails\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nString url = \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/emails\";\nString body = \"{\\\"sort\\\":{\\\"properties\\\":[{\\\"property\\\":\\\"CREATE_TIMESTAMP\\\",\\\"order\\\":\\\"DESC\\\"}]},\\\"criteria\\\":{\\\"account\\\":\\\"BY99ALFA30130000015999706777\\\",\\\"tids\\\":[\\\"T1290011\\\",\\\"T2704334\\\",\\\"T1290015\\\"],\\\"types\\\":[\\\"CANCEL\\\",\\\"CREDIT\\\",\\\"REFUND\\\"],\\\"dateRangeProperty\\\":\\\"CREATE\\\",\\\"dateRange\\\":{\\\"name\\\":\\\"MONTH\\\",\\\"range\\\":null}},\\\"settings\\\":{\\\"format\\\":\\\"PDF\\\",\\\"summary\\\":true,\\\"orientation\\\":\\\"LANDSCAPE\\\"},\\\"recipients\\\":[\\\"user@foobar.com\\\"]}\";\n\nRequest request = new Request.Builder()\n    .url(url)\n    .post(RequestBody.create(body, MediaType.parse(\"application/json; charset=utf-8\")))\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"let body = \"{\\\"sort\\\":{\\\"properties\\\":[{\\\"property\\\":\\\"CREATE_TIMESTAMP\\\",\\\"order\\\":\\\"DESC\\\"}]},\\\"criteria\\\":{\\\"account\\\":\\\"BY99ALFA30130000015999706777\\\",\\\"tids\\\":[\\\"T1290011\\\",\\\"T2704334\\\",\\\"T1290015\\\"],\\\"types\\\":[\\\"CANCEL\\\",\\\"CREDIT\\\",\\\"REFUND\\\"],\\\"dateRangeProperty\\\":\\\"CREATE\\\",\\\"dateRange\\\":{\\\"name\\\":\\\"MONTH\\\",\\\"range\\\":null}},\\\"settings\\\":{\\\"format\\\":\\\"PDF\\\",\\\"summary\\\":true,\\\"orientation\\\":\\\"LANDSCAPE\\\"},\\\"recipients\\\":[\\\"user@foobar.com\\\"]}\"\n\nvar options = {\n    method: \"POST\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/emails\",\n    headers: {\n        \"Content-Type\": \"application/json\",\n        \"Authorization\": \"Bearer <accessToken>\"\n    },\n    body: body,\n};\n\nrequire(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/statement/emails')\nvar body = \"{\\\"sort\\\":{\\\"properties\\\":[{\\\"property\\\":\\\"CREATE_TIMESTAMP\\\",\\\"order\\\":\\\"DESC\\\"}]},\\\"criteria\\\":{\\\"account\\\":\\\"BY99ALFA30130000015999706777\\\",\\\"tids\\\":[\\\"T1290011\\\",\\\"T2704334\\\",\\\"T1290015\\\"],\\\"types\\\":[\\\"CANCEL\\\",\\\"CREDIT\\\",\\\"REFUND\\\"],\\\"dateRangeProperty\\\":\\\"CREATE\\\",\\\"dateRange\\\":{\\\"name\\\":\\\"MONTH\\\",\\\"range\\\":null}},\\\"settings\\\":{\\\"format\\\":\\\"PDF\\\",\\\"summary\\\":true,\\\"orientation\\\":\\\"LANDSCAPE\\\"},\\\"recipients\\\":[\\\"user@foobar.com\\\"]}\"\n\nrequest.httpMethod = \"POST\"\nrequest.setValue(\"application/json\", forHTTPHeaderField: \"Content-type\")\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\nrequest.httpBody = body.data(using: .utf8)\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/criteria/{key}/download-settings":{"get":{"tags":["acquiring"],"summary":"Получение настроек формирования выписки.","description":"Получение настроек формирования выписки, включая доступный тип и интервал опроса статуса.","operationId":"statementDownloadSettings","x-scope":"read_acquiring_partner","parameters":[{"in":"path","name":"key","schema":{"type":"string"},"required":true,"description":"Ключ под которым хранится критерий. Уникальный в контексте пользователя."}],"responses":{"200":{"description":"Настройки формирования выписки.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadSettingsResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":21,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/emails/task":{"post":{"tags":["acquiring"],"summary":"Создать задачу на отправку выписки на email.","description":"Создать задачу на отправку выписки на email.","operationId":"createStatementTask","x-scope":"read_acquiring_partner","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementEmailRequest"}}}},"responses":{"200":{"description":"Задача успешно создана.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementTaskStatusResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":22,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/statement/emails/task/{id}/status":{"get":{"tags":["acquiring"],"summary":"Получить статус задачи на отправку выписки на email.","description":"Получить статус задачи на отправку выписки на email.","operationId":"getStatementTaskStatus","x-scope":"read_acquiring_partner","parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Идентификатор задачи."}],"responses":{"200":{"description":"Ok.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatementTaskStatusResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":23,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/transactions/{transactionId}":{"get":{"tags":["acquiring"],"summary":"Получить транзакцю по идентификатору.","description":"Получить транзакцию по идентификатору.","operationId":"getTransactionById","x-scope":"read_acquiring_partner","parameters":[{"in":"path","name":"transactionId","schema":{"type":"string"},"required":true,"description":"Идентификатор транзакции."}],"responses":{"200":{"description":"Транзакция.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transaction"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":24,"x-st-code-samples":[{"lang":"curl","sample":"curl -X GET \\\n  -H 'Authorization: Bearer <accessToken>' \\\n  https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/transactions/c72952b2-144c-11eb-b378-000000000025\n"},{"lang":"java","sample":"OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n    .url(\"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/transactions/c72952b2-144c-11eb-b378-000000000025\")\n    .get()\n    .addHeader(\"Authorization\", \"Bearer <accessToken>\")\n    .build();\n\nResponse response = client.newCall(request).execute();\n"},{"lang":"node","sample":"var options = {\n    method: \"GET\",\n    url: \"https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/transactions/c72952b2-144c-11eb-b378-000000000025\",\n    headers: {\n        'Authorization': 'Bearer <accessToken>'\n    },\n};\n\nrequest(\"request\")(options, function (error, response) {\n    if (error) throw new Error(error);\n    console.log(response.body);\n});\n"},{"lang":"swift","sample":"var request = URLRequest(url: 'https://developerhub.alfabank.by:8273/partner/1.34.0/acquiring/transactions/c72952b2-144c-11eb-b378-000000000025')\nrequest.httpMethod = \"GET\"\nrequest.setValue(\"Authorization\", forHTTPHeaderField: \"Bearer \\(accessToken)\")\n\nURLSession.shared.dataTask(with: request) { data, _, error in\n    if let data = data {\n        print(\"handle data: '\\(data))'\")\n    } else {\n        print(error)\n    }\n}.resume()\n"}],"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/orders/turnoff":{"post":{"tags":["acquiring"],"summary":"Отключение торгового эквайринга.","description":"Запрос на отключение торгового эквайринга. После его получения сервис формирует заявку в АППС и ХОК.\n","operationId":"turnOff","x-scope":"read_acquiring_partner","requestBody":{"required":true,"description":"запрос на отключение торгового эквайринга.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TurnoffRequest"}}}},"responses":{"201":{"description":"Заявка успешно создана.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCreatedResponse"}}}},"401":{"description":"Пользователь не аутентифицирован."},"403":{"description":"Нет доступа."},"404":{"description":"Не найден."}},"x-st-position":25,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","security":[{"default":["read_acquiring_partner"]}]}},"/invoices/form-data":{"get":{"tags":["acquiring"],"summary":"Получить данные для формы создания счета на оплату","description":"Возвращает сгенерированный номер заказа для формы создания инвойса.\nНомер заказа генерируется по правилу: PAY-{tid}-{yyyyMMddHHmmss}.\n","operationId":"getInvoiceFormData","parameters":[{"name":"terminalId","in":"query","required":true,"description":"Идентификатор терминала","schema":{"type":"string"}}],"responses":{"200":{"description":"Данные для формы успешно получены","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceFormDataResponse"}}}},"400":{"description":"Некорректный запрос"},"404":{"description":"Терминал не найден"}},"x-st-position":26,"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited"}}},"components":{"schemas":{"Version":{"type":"object","description":"Информация о версии системы.","properties":{"version":{"type":"string"}}},"Settings":{"type":"object","description":"Настройки приложения.","required":["serverZoneId","storesSectionEnabled"],"properties":{"serverZoneId":{"type":"string","description":"Идентификатор часового пояса местоположения сервера.","example":"Europe/Minsk"},"storesSectionEnabled":{"type":"boolean","description":"Доступность раздела \"Магазины\"."}}},"Organization":{"type":"object","description":"Организация - клиент банка.","required":["id","name","unp"],"properties":{"id":{"type":"string","description":"Идентификатор организации."},"name":{"type":"string","description":"Наименование организации."},"managerName":{"type":"string","description":"ФИО руководителя.\nОтсутствует, если значение ранее не задавалось в системе.\n"},"managerPhone":{"type":"string","description":"Номер телефона руководителя.\nОтсутствует, если значение ранее не задавалось в системе.\n"},"managerEmail":{"type":"string","description":"Адрес электронной почты руководителя.\nОтсутствует, если значение ранее не задавалось в системе.\n"},"legalAddress":{"type":"string","description":"Адрес регистрации юридического лица.\nОтсутствует, если значение ранее не задавалось в системе.\n"},"mailAddress":{"type":"string","description":"Адрес для получения почтовой корреспонденции.\nОтсутствует, если значение ранее не задавалось в системе.\n"},"unp":{"type":"string","description":"Учётный номер плательщика (УНП)."}}},"Account":{"type":"object","description":"Банковский счет клиента, на который зачисляются средства проведенные по терминалам Эквайринга.","required":["id","name","number","currency","balance","active"],"properties":{"id":{"type":"string","description":"Уникальный идентификатор счёта."},"name":{"type":"string","description":"Наименование счета."},"number":{"type":"string","description":"Номер счета (IBAN)."},"currency":{"type":"string","description":"Валюта счета (ISO 4217)."},"balance":{"type":"number","description":"Текущий остаток по счёту."},"active":{"type":"boolean","description":"Признак активности счета."}}},"AccountCriteria":{"type":"string","description":"Композитный критерий для выборки счетов под определенные нужды.\n\n- TERMINAL - Счета пользователя, связанных хотя бы с одним терминалом. Может содержать как активные так и не активные счета.\n- PAYMENT - Счета пользователя, доступных в качестве счетов для оплаты платежей.\n- CREDIT_MERCHANT - Счета пользователя, доступных в качестве счетов зачисления выручки для подключения Торгового Эквайринга.\n- CREDIT_INTERNET - Счета пользователя, доступных в качестве счетов зачисления выручки для подключения Интернет Эквайринга.\n","enum":["TERMINAL","PAYMENT","CREDIT_MERCHANT","CREDIT_INTERNET"]},"Terminal":{"type":"object","description":"Устройство для приема безналичной оплаты за товары и услуги.\nВ качестве терминала может выступать как физическое устройство, так и виртуальное устройство системы процессинга.\n","required":["id","tid","name","accountId","acquiringType","type","store","status","openDate","mcc","mid","city","address","groups"],"properties":{"id":{"type":"string","description":"Уникальный идентификатор терминала."},"tid":{"type":"string","description":"Внутрибанковский идентификатор терминала."},"organizationId":{"type":"string","description":"идентификатор организации."},"name":{"type":"string","description":"Наименование терминала."},"accounts":{"type":"array","description":"Список счетов к которым привязан терминал.\nМожет содержать как активные, так и не действующие в текущий момент счета.\n","items":{"type":"string","description":"Номер счета (IBAN)."}},"acquiringType":{"$ref":"#/components/schemas/AcquiringType"},"type":{"$ref":"#/components/schemas/TerminalType"},"store":{"type":"string","description":"Наименование торговой точки."},"status":{"$ref":"#/components/schemas/TerminalStatus"},"openDate":{"type":"string","format":"date","description":"Дата открытия контракта терминала включительно."},"closeDate":{"type":"string","format":"date","description":"Дата закрытия контракта терминала включительно.\nТерминал с закрытым контрактом имеет соответствующий статус CLOSED.\nОтсутствует, если контракт терминала не закрыт.\n"},"mcc":{"type":"string","description":"Четырёхзначный код категории торговца(состоит из цифр)."},"mid":{"type":"string","description":"Уникальный идентификатор торговца."},"country":{"type":"string","description":"Страна расположения терминала."},"city":{"type":"string","description":"Город расположения терминала."},"address":{"type":"string","description":"Адрес установки терминала."},"zip":{"type":"string","description":"Почтовый код адреса терминала."},"groups":{"type":"array","description":"Список групп в которых состоит терминал.","items":{"$ref":"#/components/schemas/TerminalGroup"}}}},"AcquiringType":{"type":"string","description":"Тип эквайринга.\n\n- MERCHANT - торговый эквайринг (прием платежей с помощью физического устройства (терминала))\n- INTERNET - интернет эквайринг (приём платежей на сайте торговца)\n- TURNOFF - отключение торгового эквайринга\n- CHANGE_TERMINAL_ADDRESS - заявка на изменение адреса терминала\n","enum":["MERCHANT","INTERNET","TURNOFF","CHANGE_TERMINAL_ADDRESS"]},"TerminalType":{"type":"string","description":"Тип терминала.\nУказывает, является ли терминал физической или электронной сущностью, а так же на состав терминального устроства.\n\n- POS - физическое устройство для считывания банковских карт и приёма платежей\n- KASSA - представляет собой POS-терминал, включающий в себя кассовый аппарат\n- SOFT - совокупность мобильного телефона, считывателя карт и мобильного приложения, позволяющего принимать платежи\n- VIRTUAL - программное приложение, позволяющее принимать платежи без наличия физической банковской карты и физического терминала\n","enum":["POS","KASSA","SOFT","VIRTUAL"]},"TerminalStatus":{"type":"string","description":"Статус активности/неактивности терминала.\n\n- ACTIVE - активен (терминал установлен на торговой точке и по нему возможно проводить операции)\n- PAUSED - на паузе (инициируется клиентом в случае, если необходимо приостоновить работу терминала)\n- BLOCKED - заблокирован (инициируется банком. Например, если клиент не платит абонентскую плату)\n- CLOSED - отключен (инициируется, если в терминале больше нет необходимости)\n","enum":["ACTIVE","PAUSED","BLOCKED","CLOSED"]},"TerminalParams":{"type":"object","description":"параметры поиска батча терминалов","properties":{"terminalStatus":{"$ref":"#/components/schemas/TerminalStatus"},"registered":{"type":"boolean","description":"регистрация терминала в РТП"},"batchSize":{"type":"integer","description":"количество терминалов в ответе"}}},"TerminalCriteria":{"type":"object","description":"Критерий выборки терминалов.\nТерминал подходит под критерий, если соответствует каждому из заданных параметров (param1 И param2 И ...).\n","properties":{"account":{"type":"string","description":"Номер счёта к которому привязан терминал.\nЕсли не задан, то account не будет участвовать в выборке.\n"},"groups":{"type":"array","description":"Список идентификаторов групп для терминалов.\nПозволяет сделать выборку терминалов, каждый из которых входит в любую из заданных групп (group1 ИЛИ group2 ИЛИ ...).\nЕсли не задан, то groups не будет участвовать в выборке.\n","items":{"type":"string","description":"Идентификатор группы в которую входит терминал."}}}},"RegisterRtpTerminalsRequest":{"type":"object","required":["terminalIds"],"properties":{"terminalIds":{"type":"array","description":"Список идентификаторов терминалов.","items":{"type":"string"}}}},"TerminalGroup":{"type":"object","description":"Группа для терминалов.\n\nПод группой понимается множество терминалов, объединённых по некому клиентскому критерию.\nОдин терминал может состоять в нескольких группах одновременно.\n","required":["id","name"],"properties":{"id":{"type":"string","description":"Идентификатор группы."},"name":{"type":"string","description":"Наименование группы.\nУникальное в контексте пользователя.\n"}}},"CreateTerminalGroup":{"type":"object","description":"Добавление новой группы терминалов (см. TerminalGroup)\nВключает в себя наименование группы и список идентификаторов терминалов.\n","required":["name","terminalIds"],"properties":{"name":{"type":"string","description":"Наименование группы.\nУникальное в контексте пользователя.\n"},"terminalIds":{"type":"array","description":"Список идентификаторов терминалов.","items":{"type":"string"},"minItems":0,"maxItems":10000}}},"Statement":{"type":"object","description":"Выписка.","required":["summary","transactions"],"properties":{"summary":{"$ref":"#/components/schemas/StatementSummary"},"transactions":{"type":"array","description":"Список транзакций.","items":{"$ref":"#/components/schemas/Transaction"}}}},"StatementSummary":{"type":"object","description":"Сводная информация выписки.","required":["totalCount","creditCount","cancelCount","grossSum","postNetSum","waitNetSum","cancelSum","feeSum","currency"],"properties":{"totalCount":{"type":"integer","format":"int64","description":"Общее количество операций."},"creditCount":{"type":"integer","format":"int64","description":"Количество операций зачисления (Transaction.type = CREDIT)."},"cancelCount":{"type":"integer","format":"int64","description":"Количество отмененных операций (Transaction.type = CANCEL или Transaction.type = REFUND)."},"grossSum":{"type":"number","description":"Сумма операций зачисления (Transaction.type = CREDIT) ВКЛЮЧАЯ комиссию (Transaction.grossAmount)."},"postNetSum":{"type":"number","description":"Сумма постированных (Transaction.status = POST) операций НЕ ВКЛЮЧАЯ комиссию (Transaction.netAmount)."},"waitNetSum":{"type":"number","description":"Сумма не постированных (Transaction.status = WAIT) операций НЕ ВКЛЮЧАЯ комиссию (Transaction.netAmount)."},"cancelSum":{"type":"number","description":"Сумма отмененных операций (Transaction.type = CANCEL или Transaction.type = REFUND) ВКЛЮЧАЯ комиссию (Transaction.grossAmount)."},"feeSum":{"type":"number","description":"Сумма комиссии."},"currency":{"type":"string","description":"Трехсимвольный код валюты (ISO 4217)."}}},"Transaction":{"type":"object","description":"Операция по перечислению средств с карт-счета клиента на банковский счет торговца.\n\n- invoice - информация о счёте на оплату по которому проведена транзакция.\n  Может отсутствовать, если система не содержит информацию о счёте на оплату, либо транзакция проведения без счёта на оплату.\n","required":["id","tid","grossAmount","netAmount","feeAmount","currency","account","cardNumber","cardType","createTimestamp","postTimestamp","highRisk","type","status","rrn"],"properties":{"id":{"type":"string","description":"Уникальный идентификатор транзакции."},"tid":{"type":"string","description":"Внутрибанковский идентификатор терминала."},"grossAmount":{"type":"number","description":"Сумма транзакции ДО вычета комиссии."},"netAmount":{"type":"number","description":"Сумма транзакции ПОСЛЕ вычета комиссии."},"feeAmount":{"type":"number","description":"Сумма комиссии."},"currency":{"type":"string","description":"Трехсимвольный код валюты (ISO 4217)."},"account":{"type":"string","description":"Номер счета."},"cardNumber":{"type":"string","description":"Номер карты с которой оплачен товар/услуга."},"paymentSystemProduct":{"type":"string","description":"Название продукта платёжной системы."},"createTimestamp":{"type":"string","format":"date-time","description":"Отметка времени создания транзакции.\nМоментом создания транзакции является проведение клиентом операции по терминалу.\n"},"postTimestamp":{"type":"string","format":"date-time","description":"Отметка времени постирования транзакции.\nПод постированием понимает зачисление средств на счёт торговца.\n"},"highRisk":{"type":"boolean","description":"Признак высокорисковой транзакции."},"type":{"$ref":"#/components/schemas/TransactionType"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"rrn":{"type":"string","description":"Номер операции."},"invoice":{"$ref":"#/components/schemas/InvoiceInfo"}}},"TransactionType":{"type":"string","description":"Тип транзакции.\n\n- CREDIT - зачисление денежных средств\n- REFUND - возврат денежных средств\n- CANCEL - отмена транзакции\n","enum":["CREDIT","REFUND","CANCEL"]},"TransactionStatus":{"type":"string","description":"Статус транзакции по признаку постирования.\n\n- WAIT - операция проведена по терминалу, но ожидает постирования\n- POST - операция постирована (сумма операции зачислена на банковский счет торговца)\n","enum":["WAIT","POST"]},"InvoiceInfo":{"type":"object","description":"Информация о счёте на оплату по которому проведена транзакция.\n","properties":{"orderId":{"type":"string","description":"Идентификатор заказа на покупку товара.\nИдентификатор задаётся торговцем.\nОтсутствует, если информация о идентификаторе не была зарегестрирована в процессинговой системе.\n"},"purpose":{"type":"string","description":"Назначение платежа.\nСодержит информацию за что платит покупатель.\nОтсутствует, если торговец не задал назначение платежа.\n"},"description":{"type":"string","description":"Дополнительная информация о платеже.\nЗадаётся торговой организацией и недоступна покупателю.\nОтсутствует, если торговец не указывал доп. информацию.\n"},"customerPhone":{"type":"string","description":"Номер телефона покупателя.\nОтсутствует, если покупатель не указывал номер в заказе, либо торговец не указал номер в счёте на оплату.\n"},"customerEmail":{"type":"string","description":"Электронная почта покупателя.\nОтсутствует, если покупатель не указывал почту в заказе, либо торговец не указал почту в счёте на оплату.\n"}}},"StatementCriteria":{"type":"object","description":"Критерий выборки транзакций для выписки.\n\n- Опциональные незаполненные свойства не используются в выборке.\n- dateRangeProperty - название свойства транзакции для которого задаётся диапазон дат.\n- dateRange - диапазон дат для выборки транзакций, входящих в данный диапазон.\n\nДля dateRange.name = CUSTOM, dateRange.range, должен быть:\n* максимальная глубина выписки - 18 месяцев, (today - range.start) < 18 месяцев\n* максимальный период выписки - 12 месяцев, (range.end - range.start) < 12 месяцев\n","required":["dateRangeProperty","dateRange"],"properties":{"account":{"type":"string","description":"Номер банковского счёта клиента.\n"},"tids":{"type":"array","description":"Список внутрибанковских идентификаторов терминалов.\nЕсли не задан, то список внутрибанковских идентификаторов терминалов не будет участвовать в выборке.\n","items":{"type":"string","description":"Внутрибанковский идентификатор терминала."}},"terminalGroupId":{"type":"string","description":"id группы терминалов. Используется как противопоставление параметру tids, для формирования выписки\nпо отдельной группе терминалов.\n"},"types":{"type":"array","description":"Список типов операций.\nЕсли не задан, то список типов операций не будет участвовать в выборке.\n","items":{"$ref":"#/components/schemas/TransactionType"}},"dateRangeProperty":{"$ref":"#/components/schemas/TransactionDateProperty"},"dateRange":{"$ref":"#/components/schemas/NamedDateRange"},"filter":{"type":"string","description":"Подстрока для поиска по свойствам транзакции.\nТранзакция соответствует критерию, если значение подстроки для поиска содержится в любом из свойств (Transaction.grossAmount, Transaction.cardNumber, Transaction.rrn).\nЕсли не задан, то строка поиска не будет участвовать в выборке.\n"}}},"StatementRequest":{"type":"object","required":["criteria","sort"],"properties":{"criteria":{"$ref":"#/components/schemas/StatementCriteria"},"sort":{"$ref":"#/components/schemas/Sort"},"settings":{"$ref":"#/components/schemas/StatementReportSettings"}}},"StatementEmailRequest":{"type":"object","title":"StatementEmailParameters","description":"Параметры отправки выписки.\n- recipients - список email адресов, получателей выписки\n- criteria - критерий выборки транзакций для выписки\n- sort - параметры сортировки. Принимаемые свойства для сортировки: TransactionSortProperty.\n- settings - настройки отчета.\n","required":["recipients","criteria","sort","settings"],"properties":{"recipients":{"type":"array","description":"Список получателей выписки.","items":{"type":"string","description":"Email адрес получателя."},"minItems":1,"maxItems":10},"criteria":{"$ref":"#/components/schemas/StatementCriteria"},"sort":{"$ref":"#/components/schemas/Sort"},"settings":{"$ref":"#/components/schemas/StatementReportSettings"}}},"StatementTaskStatusResponse":{"type":"object","title":"StatementTaskStatusResponse","description":"Ответ со статусом задачи на отправку выписки.","required":["id","status"],"properties":{"id":{"type":"string","description":"Идентификатор задачи."},"status":{"$ref":"#/components/schemas/StatementGenerationTaskStatus"}}},"StatementGenerationTaskStatus":{"type":"string","description":"Статус задачи асинхронной генерации выписки.\n\nОписание жизненного цикла:\n- PENDING - задача создана и ожидает обработки\n- PROCESSING - задача взята воркером и обрабатывается\n- COMPLETED - генерация выписки завершена, файл отправлен\n- FAILED - генерация завершилась с ошибкой после всех попыток\n","enum":["PENDING","PROCESSING","COMPLETED","FAILED"]},"NamedDateRange":{"type":"object","description":"Именованный диапазон дат.\n\n- name - Именование диапазона. Позволяет задать диапазон дат в относительном виде (указав именование диапазона).\n- range - Произвольный диапазон. Позволяет задать диапазон, указав начальную границу и конечную. Отсутствует, если name != CUSTOM.\n","required":["name"],"properties":{"name":{"$ref":"#/components/schemas/DateRangeName"},"range":{"$ref":"#/components/schemas/DateRange"}}},"DateRangeName":{"type":"string","description":"Перечисление именований диапазонов дат.\n\n- TODAY - Сегодня (текущий день).\n- YESTERDAY - Вчера (предыдущий день).\n- YESTERDAY_AND_TODAY - Вчера и сегодня (предыдущий и текущий день).\n- WEEK - Неделя (последние 7 дней). Диапазон включает текущий день и 6 предшествующих дней.\n- MONTH - Месяц.\n    Начальной границей является текущая дата минус 1 месяц. Конечной границей является текущая дата. (Например: 2020.10.10 - 2020.11.10).\n    Если в месяце начальной границы нет дня, соответствующего текущему дню месяца, то берётся последний день месяца. (Например: 2020.02.29 - 2020.03.31).\n- THREE_MONTHS - 3 месяца.\n    Начальной границей является текущая дата минус 3 месяца. Конечной границей является текущая дата. (Например: 2020.08.10 - 2020.11.10).\n    Если в месяце начальной границы нет дня, соответствующего текущему дню месяца, то берётся последний день месяца. (Например: 2020.02.29 - 2020.05.31).\n- CUSTOM - Произвольный период. Начальная и конечная даты определяются пользователем. Начальная и конечная даты включаются в диапазон.\n","enum":["TODAY","YESTERDAY","YESTERDAY_AND_TODAY","WEEK","MONTH","THREE_MONTHS","CUSTOM"]},"DateRange":{"type":"object","description":"Диапазон дат.","required":["start","end"],"properties":{"start":{"type":"string","format":"date","description":"Значение начальной границы диапазона. Граница включается в диапазон."},"end":{"type":"string","format":"date","description":"Значение конечной границы диапазона. Граница включается в диапазон."}}},"TransactionDateProperty":{"type":"string","description":"Перечисление свойств транзакции, содержащих отметки времени.\nИспользуется для указания свойства транзакции для которого задаётся диапазон дат при выборке.\n\n- CREATE - Отметка времени создания транзакции.\n- POST - Отметка времени постирования транзакции.\n","enum":["CREATE","POST"]},"TransactionSortProperty":{"type":"string","description":"Свойство транзакции по которому выполняется сортировка.\n\n- CREATE_TIMESTAMP - Отметка времени создания транзакции.\n- POST_TIMESTAMP - Отметка времени постирования транзакции.\n- RRN - Номер транзакции.\n- TID - Внутрибанковский идентификатор терминала.\n- GROSS_AMOUNT - Сумма транзакции ДО вычета комиссии.\n","enum":["CREATE_TIMESTAMP","POST_TIMESTAMP","RRN","TID","GROSS_AMOUNT"]},"Page":{"type":"object","description":"Определяет параметры постраничной навигации.\n\nСтруктура позволяет реализовать получение ограниченного объема данных\n(страницы) из большой выборки.\nЭто позволяет не передавать большой объем данных в одном запросе и \nреализовать постраничный просмотр.\nСтруктура Page интерпретируется аналогично механизму offset/limit в \nSQL запросам в СУБД (PostgreSQL, MySQL, и т.п.).\n","required":["offset","count"],"properties":{"offset":{"type":"integer","description":"Смещение относительно начала набора данных."},"count":{"type":"integer","description":"Максимальное количество возвращаемых элементов."}}},"Sort":{"type":"object","description":"Спецификация сортировки возвращаемых данных. Позволяет определить сортировку по нескольким (один и более) атрибутам.\n","properties":{"properties":{"type":"array","items":{"$ref":"#/components/schemas/SortProperty"}}}},"SortProperty":{"type":"object","description":"Спецификация сортировки для одного свойства.","required":["property","order"],"properties":{"property":{"type":"string","description":"Свойство для сортировки."},"order":{"$ref":"#/components/schemas/SortOrder"}}},"SortOrder":{"type":"string","description":"Порядок сортировки.\n\n- ASC - сортировка по возрастанию\n- DESC - сортировка по убыванию\n","enum":["ASC","DESC"]},"StatementReportSettings":{"type":"object","description":"Настройки печатной формы выписки.\n\nformat - формат печатной формы (PDF/XLSX/TXT).\n\norientation - ориентация страницы. Ниже перечислены форматы и поддерживаемые ими ориентации:\n  PDF - LANDSCAPE\n  XLSX - PORTRAIT\n  TXT - PORTRAIT\nПечатная форма в формате TXT всегда формируется со списком транзакций и сводной информацией.\n\ngroupProperty - свойство, по которому необходимо выполнить группировку транзакций в выписке.\nЕсли отсутствует, группировка не производится.\n\nincludeTransactions - флаг необходимости добавления транзакций в выписку\n\nincludeSummary - флаг необходимости добавления сводной информации в выписку\n","required":["format","orientation","includeTransactions","includeInternetAcquiringDetails","includeSummary"],"properties":{"format":{"$ref":"#/components/schemas/ResourceFormat"},"orientation":{"$ref":"#/components/schemas/Orientation"},"includeTransactions":{"type":"boolean","description":"Признак включения списка транзакций в печатную форму."},"includeInternetAcquiringDetails":{"type":"boolean","description":"Признак включения доп полей в список транзакций, \nсовершенных через виртуальный терминал.\n"},"includeSummary":{"type":"boolean","description":"Признак включения сводной информации в печатную форму."},"includePayerBankData":{"type":"boolean","description":"Признак включения информации о банке плательщика."},"groupProperty":{"$ref":"#/components/schemas/StatementGroupProperty"}}},"StatementGroupProperty":{"type":"string","description":"Свойство, по которому необходимо выполнить группировку транзакций в выписке.\n\n- TID - Внутрибанковский идентификатор терминала.\n","enum":["TID"]},"ResourceFormat":{"type":"string","description":"Формат ресурса (отчета, печатной формы, и т.п).\n","enum":["PDF","XLSX","TXT","DOCX"]},"Orientation":{"type":"string","description":"Ориентация страницы.\n- PORTRAIT - книжная\n- LANDSCAPE - альбомная\n","enum":["PORTRAIT","LANDSCAPE"]},"SalePoint":{"type":"object","description":"Торговая точка.\n","required":["contactName","contactPhone","contactEmail","mccGroup"],"properties":{"contactName":{"type":"string","description":"ФИО контактного лица.","pattern":"^[A-Za-zА-Яа-яІЎЁёіў\\-‘'’ ]+$","maxLength":100},"contactPhone":{"type":"string","description":"Номер телефона контактного лица.","pattern":"^\\+375\\d{9}$"},"contactEmail":{"type":"string","description":"Адрес электронной почты контактного лица.","pattern":"^[a-zA-Z0-9!#$%\\u0026\\u0027*+\\/=?^_`‘{|}~-]+(?:\\.[a-zA-Z0-9!#$%\\u0026\\u0027*+\\/=?^_`‘{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$","maxLength":90},"mccGroup":{"$ref":"#/components/schemas/MccGroup"},"url":{"type":"string","description":"Адрес интернет-ресурса (URL).","pattern":"^(?:http(s)?:\\/\\/)?[A-Za-zА-Яа-я0-9Ёё\\-]+(\\.[A-Za-zА-Яа-я0-9Ёё\\-]+)*(\\.[A-Za-zА-Яа-я]{2,}){1}[A-Za-zА-Яа-я0-9Ёё\\/\\-\\+().,:?%'*&№ !=\\[\\]@\\$#;]*$","maxLength":90}}},"Region":{"type":"string","description":"Область.","enum":["BREST","VITEBSK","GOMEL","GRODNO","MINSK","MOGILEV"]},"MccGroup":{"type":"string","description":"Группа видов деятельности торговцев.\n- RESTAURANT - Рестораны.\n- BEAUTY - Красота.\n- SUPERMARKET - Супермаркеты.\n- FAST_FOOD - ФастФуд.\n- CLOTHES_SHOES - Одежда и обувь.\n- REPAIRS - Стройматериалы, товары для дома,ремонт.\n- ENTERTAINMENT_SPORT - Развлечения и спорт.\n- CONFECTIONERY - Кондитерские и булочные.\n- VET - Ветеренарные услуги, зоомагазины.\n- FLORISTICS - Флористика.\n- HEALTH - Здоровье.\n- AUTO_REPAIRS - Автосервис.\n- AUTO_PARTS - Автотовары.\n- SECOND_HAND - Магазины second hand,б/у товары.\n- JOURNEY - Путешествия и транспорт.\n- TRAVEL_AGENCY - Турфирмы.\n- SOFTWARE_EQUIPMENT - Оборудование и ПО.\n- ADDS - Рекламные услуги.\n- GAMBLING - Азартные игры.\n- ELECTRONICS - Техника и электроника.\n- PHOTO_STUDIO - Фотостудии,фотолабаратории.\n- TAXI - Такси.\n- OTHER - Иные.\n","enum":["RESTAURANT","BEAUTY","SUPERMARKET","FAST_FOOD","CLOTHES_SHOES","REPAIRS","ENTERTAINMENT_SPORT","CONFECTIONERY","VET","FLORISTICS","HEALTH","AUTO_REPAIRS","AUTO_PARTS","SECOND_HAND","JOURNEY","TRAVEL_AGENCY","SOFTWARE_EQUIPMENT","ADDS","GAMBLING","ELECTRONICS","PHOTO_STUDIO","TAXI","OTHER"]},"Order":{"type":"object","description":"Базовая структура заявки на подключение Эквайринга.\n","required":["id","status","acquiringType","creditAccounts","signerName","signerPosition","confirmationDocumentType","organizationLegalAddress","salePoint","offers"],"discriminator":{"propertyName":"acquiringType","mapping":{"INTERNET":"#/components/schemas/InternetOrder","MERCHANT":"#/components/schemas/MerchantOrder","TURNOFF":"#/components/schemas/TurnoffOrder","CHANGE_TERMINAL_ADDRESS":"#/components/schemas/ChangeTerminalAddressOrder"}},"properties":{"id":{"type":"string","description":"Уникальный идентификатор заявки на подключение Эквайринга."},"status":{"$ref":"#/components/schemas/OrderStatus"},"acquiringType":{"$ref":"#/components/schemas/AcquiringType"},"creditAccounts":{"type":"array","description":"Список счетов для зачисления выручки.","items":{"type":"string"},"minItems":1,"maxItems":4},"signerName":{"type":"string","description":"ФИО подписывающего документы.","pattern":"^[A-Za-zА-Яа-яІЎЁёіў\\-‘'’ ]+$","maxLength":100},"signerPosition":{"type":"string","description":"Должность подписывающего документы.","pattern":"^[A-Za-zА-Яа-я0-9ІЎЁёіў\\/\\-+().,:?%'*&№! ]+$","maxLength":90},"confirmationDocumentType":{"$ref":"#/components/schemas/ConfirmationDocumentType"},"confirmationDocumentNumber":{"type":"string","description":"Номер документа подтверждающего право подписи.\nНе задаётся, если confirmationDocumentType = CHARTER.\n","pattern":"^[A-Za-zА-Яа-я0-9ІЎЁёіў\\/\\-+().,:?%'*&№! ]+$","maxLength":50},"confirmationDocumentCreateDate":{"type":"string","format":"date","description":"Дата выдачи документа подтверждающего право подписи.\nНе может быть позже текущего дня (включительно).\nНе задаётся, если confirmationDocumentType = CHARTER.\n"},"organizationLegalAddress":{"type":"string","description":"Адрес регистрации юридического лица."},"salePoint":{"$ref":"#/components/schemas/SalePoint"},"offers":{"type":"array","description":"Список выбранных услуг.\n\nОбязательный набор услуг для интернет Эквайринга:\n  - CREDITING_PROCEEDS_NEXT_DAY / CREDITING_PROCEEDS_TODAY\nОбязательный набор услуг для торгового Эквайринга:\n  - CREDITING_PROCEEDS_NEXT_DAY / CREDITING_PROCEEDS_TODAY\n  - TERMINAL_BUY / TERMINAL_RENT\n","items":{"$ref":"#/components/schemas/Offer"}}}},"OrderStatus":{"type":"string","description":"Статус заявки на подключение Эквайринга.\n- PROCESSING - находится в обработке.\n- SIGNING - на подписании.\n- COMPLETED - исполнена.\n- DECLINED - отклонена.\n","enum":["PROCESSING","SIGNING","COMPLETED","DECLINED"]},"MerchantOrder":{"type":"object","description":"Заявка на подключение торгового Эквайринга.\n\n- paymentMethod - способ оплаты за обязательные платежи для подключения Альфа-Кассы. Заполняются для торгового Эквайринга с Альфа-Кассой.\n","allOf":[{"$ref":"#/components/schemas/Order"},{"required":["estimateDaySum","estimateDayCount","salePointName"],"properties":{"paymentMethod":{"$ref":"#/components/schemas/AlfaKassaPaymentMethod"},"estimateDaySum":{"type":"number","description":"Предполагаемая сумма оборота операций по терминалу в сутки."},"estimateDayCount":{"type":"integer","format":"int64","description":"Предполагаемое количество операций по терминалу в сутки."},"salePointName":{"type":"string","description":"Наименование торгового объекта.","pattern":"^[A-Za-zА-Яа-я0-9ІЎЁёіў\\/\\-+().,:?%'*&№!\" ]+$","maxLength":90}}}]},"TurnoffRequest":{"type":"object","description":"Запрос на подключение торгового Эквайринга.\n","required":["date","description","tids"],"properties":{"date":{"type":"string","format":"date","description":"Дата отключения торгового эквайринга."},"description":{"type":"string","description":"Причина отключения торгового эквайринга."},"tids":{"type":"array","description":"Список tid терминалов.","items":{"type":"string","description":"tid терминала."}}}},"TurnoffOrder":{"type":"object","description":"Заявка на отключение торгового Эквайринга.\n","allOf":[{"$ref":"#/components/schemas/Order"},{"required":["date","description","tids"],"properties":{"date":{"type":"string","format":"date","description":"Дата отключения торгового эквайринга."},"description":{"type":"string","description":"Причина отключения торгового эквайринга."},"tids":{"type":"array","description":"Список tid терминалов.","items":{"type":"string","description":"tid терминала."}}}}]},"TurnoffReasonsResponse":{"type":"object","required":["reasons"],"properties":{"reasons":{"type":"array","description":"Причины расторжения торгового эквайринга","items":{"type":"string"}}}},"ChangeTerminalAddressOrder":{"type":"object","description":"Заявка на изменение адреса терминала.\n","allOf":[{"$ref":"#/components/schemas/Order"},{"required":["changeDate","newAddress","tid"],"properties":{"changeDate":{"type":"string","format":"date","description":"Дата изменения адреса терминала."},"newAddress":{"type":"string","description":"Новый адрес терминала."},"tid":{"type":"string","description":"tid терминала."}}}]},"ChangeTerminalAddressRequest":{"type":"object","description":"Запрос на изменение адреса терминала.\n","required":["changeDate","newAddress","tid"],"properties":{"changeDate":{"type":"string","format":"date","description":"Дата изменения адреса терминала."},"newAddress":{"type":"string","description":"Новый адрес терминала."},"tid":{"type":"string","description":"tid терминала."}}},"CreateStatementScheduleRequest":{"type":"object","description":"запрос на создание расписания отправки выписок.\n","required":["name","period","time","format","informationTypes","emails","account","internetAcquiringOrderInformation","tids","transactionTypes","transactionDate","includePayerBankData"],"properties":{"id":{"type":"string","description":"идентификатор расписания."},"name":{"type":"string","description":"имя расписания."},"period":{"$ref":"#/components/schemas/StatementSchedulePeriod"},"time":{"type":"string","description":"время отправки email."},"format":{"$ref":"#/components/schemas/ResourceFormat"},"informationTypes":{"type":"array","description":"список операций или сводная информация, или всё вместе. TRANSACTIONS, SUMMARY","items":{"type":"string"}},"emails":{"type":"array","description":"список email для отправки выписки.","items":{"type":"string"}},"account":{"type":"string"},"tids":{"type":"array","description":"список tid терминалов для формирования выписки.","items":{"type":"string"}},"internetAcquiringOrderInformation":{"type":"boolean","description":"чекбокс включения информации о заказах(доступен только для формата xlsx)"},"transactionTypes":{"type":"array","description":"Список типов операций. CREDIT, REFUND, CANCEL\nЕсли не задан, то список типов операций не будет участвовать в выборке.\n","items":{"type":"string"}},"transactionDate":{"$ref":"#/components/schemas/TransactionDateProperty"},"includePayerBankData":{"type":"boolean","description":"Признак включения информации о банке плательщика."}}},"StatementSchedulePeriod":{"type":"string","enum":["DAILY","MONTHLY"]},"DownloadSettingsResponse":{"type":"object","required":["downloadType","statusPollingInterval"],"properties":{"downloadType":{"type":"string","description":"Тип формирования выписки (синхронный или асинхронный).","enum":["SYNC","ASYNC"]},"statusPollingInterval":{"type":"integer","format":"int64","description":"Интервал опроса статуса задачи в миллисекундах.","example":10000}}},"CreatedStatementScheduleResponse":{"type":"object","required":["id","name","period","time","format","account","internetAcquiringOrderInformation","informationTypes","transactionTypes","emails","tids","lastSendingTime","transactionDate","includePayerBankData"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"period":{"$ref":"#/components/schemas/StatementSchedulePeriod"},"time":{"type":"string"},"format":{"$ref":"#/components/schemas/ResourceFormat"},"informationTypes":{"type":"array","description":"список операций или сводная информация, или всё вместе.","items":{"type":"string"}},"emails":{"type":"array","description":"список email для отправки выписки.","items":{"type":"string"}},"account":{"type":"string"},"internetAcquiringOrderInformation":{"type":"boolean","description":"чекбокс включения информации о заказах(доступен только для формата xlsx)"},"tids":{"type":"array","description":"список tid терминалов для формирования выписки.","items":{"type":"string"}},"transactionTypes":{"type":"array","description":"Список типов операций.\nЕсли не задан, то список типов операций не будет участвовать в выборке.\n","items":{"type":"string"}},"lastSendingTime":{"type":"string","format":"date-time","description":"Время последней отправки выписки."},"transactionDate":{"$ref":"#/components/schemas/TransactionDateProperty"},"includePayerBankData":{"type":"boolean","description":"Признак включения информации о банке плательщика."}}},"StatementSchedulesResponse":{"type":"object","properties":{"statementSchedules":{"type":"array","items":{"$ref":"#/components/schemas/CreatedStatementScheduleResponse"}}}},"DeleteStatementScheduleRequest":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","description":"список id расписаний для удаления","items":{"type":"string"}}}},"InternetOrder":{"type":"object","description":"Заявка на подключение интернет-Эквайринга.\n","allOf":[{"$ref":"#/components/schemas/Order"},{"required":["limits"],"properties":{"limits":{"type":"array","description":"Список лимитов, устанавливаемых на терминал.","items":{"$ref":"#/components/schemas/TerminalLimit"}}}}]},"ConfirmationDocumentType":{"type":"string","description":"Тип документа подтверждающего право подписи.\n- ENTRUSTMENT - доверенность\n- CHARTER - устав\n- CERTIFICATE - свидетельство о государственной регистрации\n- NONE - в случае отсутствия документа подтверждения. Только для обратной совместимости.\n    Не используется для создания заявок.\n","enum":["ENTRUSTMENT","CHARTER","CERTIFICATE","NONE"]},"AlfaKassaPaymentMethod":{"type":"object","description":"Способ оплаты за обязательные платежи для подключения Альфа-Кассы.\n\n- pks - способ оплаты за информационное обслуживание пользователя ПКС (программная кассовая система).\n- skko - способ оплаты за регистрацию Альфа-Кассы в системе контроля кассового оборудования (СККО).\n- sko - способ оплаты за СКО (средство контроля оператора) Альфа-Кассы.\n","required":["pks","skko","sko"],"properties":{"pks":{"$ref":"#/components/schemas/PaymentMethod"},"skko":{"$ref":"#/components/schemas/PaymentMethod"},"sko":{"$ref":"#/components/schemas/PaymentMethod"},"account":{"type":"string","description":"Номер счёта для оплаты платежей в формате IBAN. Отсутсвует если способ оплаты за pks, skko и sko не ACCOUNT."}}},"Document":{"type":"object","description":"Документ.\n\nПри подаче заявки на подключение Эквайринга в системе создаётся один и более документов:\n- документ соответствующий заявке\n- документ связанного с заявкой платежа\n- и тп.\n\nДля определения на основе чего был сформирован документ, используется параметр type.\nДокумент формируется для предоставления клиенту на подписание.\n","required":["id","orderId","origin","createDate","name","recipientName","number"],"properties":{"id":{"type":"string","description":"Уникальный идентификатор документа."},"orderId":{"type":"string","description":"Идентификатор заявки с которой связан документ."},"origin":{"$ref":"#/components/schemas/OriginType"},"createDate":{"type":"string","format":"date","description":"Дата создания документа."},"name":{"type":"string","description":"Наименование документа."},"recipientName":{"type":"string","description":"Наименование получателя документа."},"number":{"type":"string","description":"Порядковый номер документа, относительно однотипных документов текущего пользователя."}}},"OriginType":{"type":"string","description":"Тип источника на основе которого сформирован документ.\n\n- ORDER - на основе заявки на подключение Эквайринга\n- PAYMENT - на основе платежа за выбранные доп. услуги при оформлении заявки на подключение Эквайринга\n","enum":["ORDER","PAYMENT"]},"Payment":{"type":"object","description":"Платёж.\n\nПлатежи назначаются за выбранные доп. услуги при оформлении заявки на подключение Эквайринга.\nНапример: за Альфа-кассу, за заключение договора с ИИЦ по налогам и сборам и др.\n","required":["senderName","senderAccount","executeDate","recipientUnn","recipientName","recipientAccount","recipientBic","recipientBankName","sum","currency","description","priority"],"properties":{"senderName":{"type":"string","description":"Наименование отправителя платежа."},"senderAccount":{"type":"string","description":"Счёт списания (IBAN)."},"executeDate":{"type":"string","format":"date","description":"Дата по которую должен быть исполнен платёж."},"recipientUnn":{"type":"string","description":"УНП получателя платежа."},"recipientName":{"type":"string","description":"Наименование получателя платежа."},"recipientAccount":{"type":"string","description":"Номер счета получателя платежа (IBAN)."},"recipientBic":{"type":"string","description":"Банковский идентификационный код (BIC) получателя."},"recipientBankName":{"type":"string","description":"Наименование банка получателя."},"sum":{"type":"number","description":"Сумма платежа."},"currency":{"type":"string","description":"Валюта платежа."},"description":{"type":"string","description":"Описание назначения платежа."},"priority":{"type":"string","description":"Приоритет платежа."}}},"OfferCriteria":{"type":"object","description":"Критерий выборки услуг.\n\n- acquiringType - тип Эквайринга при подключении которого предоставляются услуги\n","required":["acquiringType"],"properties":{"acquiringType":{"$ref":"#/components/schemas/AcquiringType"}}},"Offer":{"type":"object","description":"Базовая структура услуги.\nДополнительное предложение клиенту при оформлении заявки на подключение Эквайринга.\n","required":["id","acquiringType","type"],"discriminator":{"propertyName":"type","mapping":{"ALFA_KASSA":"#/components/schemas/AlfaKassaOffer","CREDITING_PROCEEDS_NEXT_DAY":"#/components/schemas/CreditingProceedsNextDayOffer","CREDITING_PROCEEDS_TODAY":"#/components/schemas/CreditingProceedsTodayOffer","SIM_CARD":"#/components/schemas/SimCardOffer","TAX_AGREEMENT_CONCLUDE":"#/components/schemas/TaxAgreementConcludeOffer","TAX_AGREEMENT_PROVIDE":"#/components/schemas/TaxAgreementProvideOffer","TERMINAL_BUY":"#/components/schemas/TerminalBuyOffer","TERMINAL_RENT":"#/components/schemas/TerminalRentOffer"}},"properties":{"id":{"type":"string","description":"Уникальный идентификатор услуги."},"acquiringType":{"$ref":"#/components/schemas/AcquiringType"},"type":{"$ref":"#/components/schemas/OfferType"}}},"OfferType":{"type":"string","description":"Тип услуги.\n- ALFA_KASSA - приобретение Альфа-Кассы\n- CREDITING_PROCEEDS_NEXT_DAY - зачисление выручки \"на следующий день\"\n- CREDITING_PROCEEDS_TODAY - зачисление выручки \"день в день\"\n- SIM_CARD - приобретение sim-карты\n- TAX_AGREEMENT_CONCLUDE - заключение договора с Информационно-издательским центром по налогам и сборам\n- TAX_AGREEMENT_PROVIDE - предоставление ранее заключённого договора с Информационно-издательским центром по налогам и сборам\n- TERMINAL_BUY - приобретение терминала\n- TERMINAL_RENT - аренда терминала\n","enum":["ALFA_KASSA","CREDITING_PROCEEDS_NEXT_DAY","CREDITING_PROCEEDS_TODAY","SIM_CARD","TAX_AGREEMENT_CONCLUDE","TAX_AGREEMENT_PROVIDE","TERMINAL_BUY","TERMINAL_RENT"]},"AlfaKassaOffer":{"description":"Услуга по приобретению Альфа-Кассы.\n\n- dataProcessingPayment - детали платежа за обработку данных на Альфа-Кассе.\n- sko - детали платежа за СКО (средство контроля оператора) Альфа-Кассы.\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["dataProcessingPayment","sko"],"properties":{"dataProcessingPayment":{"$ref":"#/components/schemas/PaymentDetails"},"sko":{"$ref":"#/components/schemas/PaymentDetails"},"kassaAdministratorName":{"type":"string","description":"ФИО администратора Альфа-Кассы.\nОбязательно, если услуга выбрана при оформлении заявки.\n","pattern":"^[A-Za-zА-Яа-яІЎЁёіў\\-‘'’ ]+$","maxLength":100},"kassaAdministratorPassportId":{"type":"string","description":"Идентификационный номер паспорта администратора Альфа-Кассы.\nОбязательно, если услуга выбрана при оформлении заявки.\n","pattern":"^[A-Z0-9]+$","maxLength":14,"minLength":14},"mailAddress":{"type":"string","description":"Адрес организации для получения почтовой корреспонденции.\nОбязательно, если услуга выбрана при оформлении заявки.\n","pattern":"^[А-ЯЁ0-9\\/\\-., ]+$"}}}]},"CreditingProceedsTodayOffer":{"description":"Услуга по зачислению выручки день в день.\n\n- cardType - тип карт, на операции по которым действует процентная ставка (interestRate)\n- paymentType - вид оплаты при котором взимается процентная ставка (interestRate)\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["interestRate","minAmount","currency","cardType","paymentType"],"properties":{"interestRate":{"type":"number","description":"Процентная ставка, отчисляемая с каждой операции, за пользование услугой."},"minAmount":{"type":"number","description":"Минимальный платеж с каждой операции за пользование услугой."},"currency":{"type":"string","description":"Трехсимвольный код валюты минимального платежа (ISO 4217)."},"cardType":{"$ref":"#/components/schemas/IssuerCardType"},"paymentType":{"$ref":"#/components/schemas/PaymentType"}}}]},"CreditingProceedsNextDayOffer":{"description":"Услуга по зачислению выручки на следующий день.\n\n- cardType - тип карт, на операции по которым действует процентная ставка (interestRate)\n- paymentType - вид оплаты при котором взимается процентная ставка (interestRate)\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["interestRate","minAmount","currency","cardType","paymentType"],"properties":{"interestRate":{"type":"number","description":"Процентная ставка, отчисляемая с каждой операции, за пользование услугой."},"minAmount":{"type":"number","description":"Минимальный платеж с каждой операции за пользование услугой."},"currency":{"type":"string","description":"Трехсимвольный код валюты минимального платежа (ISO 4217)."},"cardType":{"$ref":"#/components/schemas/IssuerCardType"},"paymentType":{"$ref":"#/components/schemas/PaymentType"}}}]},"IssuerCardType":{"type":"string","description":"Тип карты в зависимости от выпустившего её эмитента.\n- ALFA - карта эмитированная Альфа-Банком Республики Беларусь.\n- BELARUS - карта эмитированная банком-резидентом Республики Беларусь (кроме Альфа-Банка).\n- NON_RESIDENT_BELARUS_CURRENCY - карта в валюте Республики Беларусь, эмитированная банком нерезидентом.\n- NON_RESIDENT_FOREIGN_CURRENCY - карта в иностранной валюте, эмитированная банком нерезидентом.\n","enum":["ALFA","BELARUS","NON_RESIDENT_BELARUS_CURRENCY","NON_RESIDENT_FOREIGN_CURRENCY"]},"PaymentType":{"type":"string","description":"Вид оплаты.\n- CARD - оплата пластиковой картой через терминал.\n- PAYMENT_SYSTEM - оплата через платёжную систему (SamsungPay, ApplePay и пр.).\n- INSNC - оплата через приложение INSNC.\n","enum":["CARD","PAYMENT_SYSTEM","INSNC"]},"SimCardOffer":{"description":"Услуга по приобретению sim-карты.\n\n- payment - детали платежа за приобретение sim-карты.\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["payment"],"properties":{"payment":{"$ref":"#/components/schemas/PaymentDetails"}}}]},"TaxAgreementConcludeOffer":{"description":"Услуга на заключение нового договора с Информационно-издательским центром по налогам и сборам.\n\n- skko - детали платежа за регистрацию Альфа-Кассы в системе контроля кассового оборудования (СККО).\n- pks - детали платежа за информационное обслуживание пользователя ПКС (программная кассовая система).\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["skko","pks"],"properties":{"skko":{"$ref":"#/components/schemas/PaymentDetails"},"pks":{"$ref":"#/components/schemas/PaymentDetails"}}}]},"TaxAgreementProvideOffer":{"description":"Услуга на предоставление ранее заключённого договора с Информационно-издательским центром по налогам и сборам.\n\n- skko - детали платежа за регистрацию Альфа-Кассы в системе контроля кассового оборудования (СККО).\n- pks - детали платежа за информационное обслуживание пользователя ПКС (программная кассовая система).\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["skko","pks","contractNumber","contractCreateDate"],"properties":{"skko":{"$ref":"#/components/schemas/PaymentDetails"},"pks":{"$ref":"#/components/schemas/PaymentDetails"},"contractNumber":{"type":"string","description":"Номер договора с налоговой.\nОбязательно, если услуга выбрана при оформлении заявки.\n","pattern":"^\\d{9}$"},"contractCreateDate":{"type":"string","format":"date","description":"Дата оформления договора с налоговой.\nНе может быть позже текущего дня.\nОбязательно, если услуга выбрана при оформлении заявки.\n"}}}]},"TerminalBuyOffer":{"description":"Услуга по приобретению терминала.\n\n- payment - детали платежа за приобретение терминала.\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["terminalName","payment"],"properties":{"terminalName":{"type":"string","description":"Наименование модели терминала."},"payment":{"$ref":"#/components/schemas/PaymentDetails"}}}]},"TerminalRentOffer":{"description":"Услуга по аренде терминала.\n\n- payment - детали платежа за аренду терминала.\n","allOf":[{"$ref":"#/components/schemas/Offer"},{"required":["terminalName","payment"],"properties":{"terminalName":{"type":"string","description":"Наименование модели терминала."},"payment":{"$ref":"#/components/schemas/PaymentDetails"}}}]},"PaymentDetails":{"description":"Детали платежа за услугу.","required":["sum","currency","nds","repeatability"],"properties":{"sum":{"type":"number","description":"Сумма платежа."},"currency":{"type":"string","description":"Валюта."},"nds":{"type":"boolean","description":"Признак отображения наличия НДС (налог на добавленную стоимость)."},"repeatability":{"$ref":"#/components/schemas/PaymentRepeatability"}}},"PaymentRepeatability":{"type":"string","description":"Повторяемость платежа.\n- ONCE - единоразовый платёж.\n- MONTHLY - ежемесячный платёж.\n","enum":["ONCE","MONTHLY"]},"PaymentMethod":{"type":"string","description":"Способ оплаты.\n- ACCOUNT - оплата со счета Альфа-Банка.\n- REQUISITES - выслать реквизиты для оплаты.\n","enum":["ACCOUNT","REQUISITES"]},"Invoice":{"type":"object","description":"Счет на оплату.\nСчет выставляет торговец (организация) своему покупателю (физ. лицу).\n","required":["id","terminalId","customerEmail","orderId","createTimestamp","expirationTimestamp","purpose","amount","refundAmount","currency","status"],"properties":{"id":{"type":"string","description":"Уникальный идентификатор счета на оплату."},"rbsId":{"type":"string","description":"Идентификатор счета на оплату в системе RBS.\nВозвращается системой RBS после создания счета на оплату.\n"},"insncId":{"type":"string","description":"Идентификатор счета от INSNC.\nВозвращается приложением INSNC после создания счета на оплату.\nОбязателен для вида оплаты инвойса INSNC.\n"},"terminalId":{"type":"string","description":"Идентификатор терминала.\nИспользуется значение Terminal.id\n"},"customerName":{"type":"string","description":"ФИО покупателя (физ. лица).\nОтсутствует, если покупатель не указал свое ФИО торговцу\n","pattern":"^[A-Za-zА-Яа-яІЎЁёіў\\-‘'’ ]+$","maxLength":100},"customerEmail":{"type":"string","description":"Адрес электронной почты покупателя (физ. лица).","pattern":"^[a-zA-Z0-9!#$%\\u0026\\u0027*+\\/=?^_`‘{|}~-]+(?:\\.[a-zA-Z0-9!#$%\\u0026\\u0027*+\\/=?^_`‘{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$","maxLength":255},"orderId":{"type":"string","description":"Идентификатор заказа на покупку товара.\nИдентификатор задаётся торговцем.\nОтсутствует, если торговец не использует идентификаторы для заказов.\n","pattern":"^[A-Za-z0-9-_]+$","maxLength":32},"accountNumber":{"type":"string","description":"Номер счёта (IBAN)."},"organizationId":{"type":"string","description":"Идентификатор организации."},"organizationName":{"type":"string","description":"Наименование организации."},"organizationUnp":{"type":"string","description":"УНП организации."},"createTimestamp":{"type":"string","format":"date-time","description":"Отметка времени создания счёта на оплату."},"expirationTimestamp":{"type":"string","format":"date-time","description":"Отметка времени, до которой нужно оплатить счет."},"purpose":{"type":"string","description":"Назначение платежа.\nСодержит информацию за что платит покупатель (физ. лицо).\nИспользуется как покупателем, так и торговцем.\n","maxLength":598},"description":{"type":"string","description":"Дополнительная информация о платеже. \nИспользуется только торговцем.\n","maxLength":250},"amount":{"type":"number","description":"Сумма оплаты. Не изменяется от наличия возвратов по счёту."},"refundAmount":{"type":"number","description":"Сумма всех возвращённых средств по текущему счёту.\nСчёт по которому проводился возврат имеет соответствующий статус 'REFUNDED'.\n"},"currency":{"type":"string","description":"Трехбуквенный код валюты в формате ISO 4217."},"paymentUrl":{"type":"string","description":"URL платежной формы.\n"},"insncDeepLink":{"type":"string","description":"Deep link в мобильное приложение INSNC для совершения оплаты.\n"},"status":{"$ref":"#/components/schemas/InvoiceStatus"},"paymentType":{"$ref":"#/components/schemas/PaymentType"},"paymentSelectionUrl":{"type":"string","description":"URL страницы оплаты МС эквайринг."},"commissionAmount":{"type":"number","description":"Сумма списанной комиссии"}}},"InvoiceStatus":{"type":"string","description":"Статус платежа.\n- CREATED - Сформирован\n- COMPLETED - Оплачен\n- DECLINED - Отклонён\n- REFUNDED - Возврат\n","enum":["CREATED","COMPLETED","DECLINED","REFUNDED"]},"InvoiceStatusRequest":{"type":"object","description":"Запрос на передачу статуса счёта на оплату из приложения insnc.\n","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/InvoiceStatus"},"message":{"type":"string","description":"Сообщение.\n"}}},"InvoicePaymentTypeRequest":{"type":"object","description":"Представляет выбор пользователем способа оплаты.\nСодержит необходимые идентификаторы и данные конфигурации для выбранного способа оплаты.\n","properties":{"rbsId":{"type":"string","description":"Идентификатор регистрации инвойса в RBS.\nТребуется для обработки способа оплаты CARD.\nМожет быть null для способа оплаты INSNC.\n"},"insncId":{"type":"string","description":"Идентификатор регистрации инвойса в INSNC.\nТребуется для обработки способа оплаты INSNC.\nМожет быть null для способа оплаты CARD.\n"},"paymentUrl":{"type":"string","description":"URL страницы оплаты картой.\nЗаполняется только при выборе способа оплаты CARD.\nМожет быть null, если выбран способ оплаты INSNC.\n"},"insncDeepLink":{"type":"string","description":"Deep link для совершения оплаты через мобильное приложение INSNC.\nЗаполняется только при выборе способа оплаты INSNC.\nМожет быть null, если выбран способ оплаты CARD.\n"},"paymentType":{"$ref":"#/components/schemas/PaymentType"}},"required":["paymentType"]},"InvoicePaymentTypeResponse":{"type":"object","description":"Ответ на выбор способа оплаты invoice.\nСодержит сгенерированный URL для обработки платежа.\n","properties":{"paymentUrl":{"type":"string","description":"URL для обработки платежа.\nДля CARD: URL страницы оплаты RBS, сгенерированный после регистрации invoice в RBS.\nДля INSNC: Deep link для навигации в мобильном приложении INSNC.\nДля PAYMENT_SYSTEM: URL или deep link для соответствующей платёжной системы.\n"},"paymentType":{"$ref":"#/components/schemas/PaymentType"}},"required":["paymentUrl","paymentType"]},"InvoicePreconditionsRule":{"type":"string","description":"Правило из предусловий создания счёта на оплату.\n- PERMISSION - наличие у пользователя прав на создание счёта на оплату\n- INTERNET_ACQUIRING - наличие у пользователя подключённой услуги Интернет-Эквайринг\n","enum":["PERMISSION","INTERNET_ACQUIRING"]},"InvoiceSortProperty":{"type":"string","description":"Свойство счёта на оплату по которому выполняется сортировка.\n\n- CREATE_TIMESTAMP - Отметка времени создания счёта на оплату.\n","enum":["CREATE_TIMESTAMP"]},"RtpInvoiceSortProperty":{"type":"string","description":"Свойство RTP-инвойса по которому выполняется сортировка.\n\n- CREATE_TIMESTAMP - Отметка времени создания RTP-инвойса.\n- EXPIRATION_TIMESTAMP - Срок оплаты RTP-инвойса.\n- MERCHANT_ORDER_ID - Номер заказа торговца.\n","enum":["CREATE_TIMESTAMP","EXPIRATION_TIMESTAMP","MERCHANT_ORDER_ID"]},"Exception":{"description":"Исключение (базовая структура ошибки).\nПередается в теле ответа и содержит расширенную информацию об ошибке.\n","properties":{"id":{"type":"string","description":"Уникальный идентификатор ошибки."},"type":{"type":"string","description":"Тип ошибки, т.е. имя текущей структуры передающей информацию об ошибке (Exception, ValidationException и т.п.).\n"},"message":{"type":"string","description":"Текстовое сообщение об ошибке (nullable)."}}},"ValidationException":{"description":"Исключение используется в случае ошибок валидации.\nHTTP статус код для ошибок валидации: 422 Unprocessable entity.\n","allOf":[{"$ref":"#/components/schemas/Exception"},{"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}}]},"PreconditionsCheckException":{"description":"Исключение используется в случае невыполнения правила предусловий.\nHTTP статус код для исключения: 422 Unprocessable entity.\n","allOf":[{"$ref":"#/components/schemas/Exception"},{"properties":{"rule":{"type":"string","description":"Наименование невыполненного правила."}}}]},"ValidationError":{"description":"Конкретная ошибка валидации.\nСодержит описание ошибочной ситуациии и контекстную информацию.\n","required":["message"],"properties":{"message":{"type":"string","description":"Описание ошибки валидации."},"context":{"type":"string","description":"Информация о валидируемом объекте.\nВ зависимости от условий использования может содержать: идентификатор правила,\nидентификатор проверяемого объекта и пр. информация, позволяющая клиенту сопоставить\nошибку с проверяемым объектом.\n"}}},"ObjectCreatedResponse":{"type":"object","description":"Структура ответа, возращаемая после успешного создания объекта.","properties":{"id":{"type":"string","description":"ID созданного объекта."}}},"InvoiceCreatedResponse":{"type":"object","description":"Результат успешного создания invoice.","properties":{"id":{"type":"string","description":"id созданного invoice."},"paymentSelectionUrl":{"type":"string","description":"url страницы оплаты МС эквайринг."}}},"OrderCreatedResponse":{"type":"object","description":"Результат успешного создания заявки.\n\nid - идентификатор созданной заявки.\nsignMethod - метод подписи документа созданной заявки.\n","allOf":[{"$ref":"#/components/schemas/ObjectCreatedResponse"},{"type":"object","required":["signMethod"],"properties":{"signMethod":{"$ref":"#/components/schemas/SignMethod"}}}]},"OrderUpdatedResponse":{"type":"object","description":"Результат успешного обновления заявки.\n\n- order - обновлённая заявка.\n- signMethod - метод подписи документа обновлённой заявки.\n","required":["order","signMethod"],"properties":{"order":{"$ref":"#/components/schemas/Order"},"signMethod":{"$ref":"#/components/schemas/SignMethod"}}},"SignInfo":{"type":"object","description":"Информация о способе подписи документов для текущего пользователя.\nВсе атрибуты, за исключением order, отражают правила подписи, принятые в организации\nи не зависят от текущего пользователя.\nПоле order зависит от текущего пользователя.\n\nТекущий пользователь может подписать документ сразу после создания если выполняется любое из\nследующих случаев:\n- пользователь является первым подписантом (order == 1)\n- пользователь имеет право подписи (order > 0) и подписание параллельное (parallel: true)\n","required":["method","count","order","parallel"],"properties":{"method":{"$ref":"#/components/schemas/SignMethod"},"count":{"type":"integer","minimum":1,"description":"Общее количество подписей для документов организации."},"order":{"type":"integer","minimum":0,"description":"Порядковый номер подписи документов для текущего пользователя.\n0 - текущий пользователь не имеет права подписи.\n"},"parallel":{"type":"boolean","description":"Признак параллельного подписания документов в организации.\ntrue - параллельное, false - документы подписываются последовательно, в порядке очередности подписантов.\n"}}},"SignMethod":{"type":"string","description":"Метод подписи.\n- NONE - без подписи\n- SMS - SMS\n- KEY - ключ\n","enum":["NONE","SMS","KEY"]},"SignData":{"type":"object","description":"Информация для подписания документов, связанных с заявкой.\n","required":["documentSignContexts","order"],"properties":{"documentSignContexts":{"type":"array","items":{"$ref":"#/components/schemas/DocumentSignContext"}},"order":{"$ref":"#/components/schemas/Order"}}},"DocumentSignContext":{"type":"object","description":"Контекстная информация процесса подписи документа, ассоциированного с заявкой","required":["state","documentId"],"properties":{"state":{"type":"string","description":"Сериализованное состояние процесса подписания документа."},"documentId":{"type":"string","description":"Идентификатор подписываемого документа."},"signature":{"type":"string","description":"Подпись, сгенерированная при инициализации процесса подписания.\nОтсутствует для документа пользователя не имеющего права подписи.\n"}}},"OtpInfo":{"type":"object","description":"Результат отправки ОТП с текущей информацией о количестве оставшихся попыток генерации и таймаута между ними.","required":["requestTimeout","requestsLeft"],"properties":{"requestTimeout":{"type":"integer","description":"Время (в миллисекундах) между запросами на отправку кода","minimum":0},"requestsLeft":{"type":"integer","description":"Остаток количества запросов на отправку кода.","minimum":0}}},"Signature":{"type":"object","description":"Данные для подписи.\nНе передаётся непосредственно.\nЯвляется базовой структурой для\n  * OtpSignature\n  * KeySignature\n  * NoneSignature\n","required":["type","orderId","documentSignContext"],"properties":{"type":{"description":"Тип объекта.","enum":["OtpSignature","KeySignature","NoneSignature"]},"orderId":{"description":"Идентификатор подписываемой заявки.","type":"string"},"documentSignContext":{"description":"Контекстная информация процесса подписи документов, связанных с заявкой.\nПередаётся в неизменном виде, как был получен в SignData (в ответе на GET /orders/{orderId}/signature).\n","$ref":"#/components/schemas/DocumentSignContext"}},"discriminator":{"propertyName":"type","mapping":{"OtpSignature":"#/components/schemas/OtpSignature","KeySignature":"#/components/schemas/KeySignature","NoneSignature":"#/components/schemas/NoneSignature"}}},"OtpSignature":{"type":"object","description":"Данные для подписи методом OTP.","required":["otp"],"allOf":[{"$ref":"#/components/schemas/Signature"},{"properties":{"otp":{"type":"string","description":"Значение OTP кода."}}}]},"KeySignature":{"description":"Данные для подписи документа методом ЭЦП.","type":"object","required":["publicKeyId","signature"],"allOf":[{"$ref":"#/components/schemas/Signature"},{"properties":{"publicKeyId":{"description":"Идентификатор открытого ключа.","type":"string"},"signature":{"description":"ЭЦП подпись заявки, полученная при взаимодействии с криптоагентом.","type":"string"}}}]},"NoneSignature":{"description":"Данные для подписи документа методом ЭЦП.","type":"object","allOf":[{"$ref":"#/components/schemas/Signature"}]},"SignResult":{"type":"object","description":"Результат подписи заявки.","required":["succeed","resultMessage","order"],"properties":{"succeed":{"type":"boolean","description":"* true, если подписание завершилось успешно\n* false, если при подписании произошла ошибка\n"},"resultMessage":{"type":"string","description":"Сообщение о результате выполнения сценария подписи."},"order":{"$ref":"#/components/schemas/Order"}}},"TerminalLimitsBatchRequest":{"type":"object","description":"Объект со списком идентификаторов терминалов.\n","required":["terminalIds"],"properties":{"terminalIds":{"type":"array","description":"Список идентификаторов терминалов.\n","items":{"type":"string","pattern":"^[A-Z0-9]{2,20}$"},"minItems":1,"maxItems":1000,"example":["e59e1198-ed39-11ef-9cd2-0242ac120002","e59e147c-ed39-11ef-9cd2-0242ac120002"]}}},"TerminalLimitsBatchResponse":{"type":"object","description":"Объект с маппингом идентификаторов терминалов на списки лимитов.\n","required":["terminalLimitsMap"],"properties":{"terminalLimitsMap":{"type":"object","description":"Ассоциативный массив, где:\n- Ключи - уникальные идентификаторы терминалов\n- Значения - списки лимитов на проведение операций для соответствующего терминала\n","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/TerminalLimit"}}}}},"TerminalLimit":{"type":"object","description":"Базовая структура лимита на операции по терминалу.\n\nНакладывает ограничения на проводимые операции по текущему терминалу. \nТип накладываемого ограничения задаётся в параметре type (см. TerminalLimitType).\n","required":["type"],"discriminator":{"propertyName":"type","mapping":{"SUM":"#/components/schemas/SumTerminalLimit","COUNT":"#/components/schemas/CountTerminalLimit","REGION":"#/components/schemas/RegionTerminalLimit"}},"properties":{"type":{"$ref":"#/components/schemas/TerminalLimitType"}}},"TerminalLimitType":{"type":"string","description":"Тип лимита по виду ограничения на проводимые операции по терминалу. \n- SUM - лимит на денежную сумму операций\n- COUNT - лимит на количество операций\n- REGION - лимит на регионы, карты которых могут использоваться на терминале\n","enum":["SUM","COUNT","REGION"]},"SumTerminalLimit":{"type":"object","description":"Лимит для терминала на сумму операций.\n\nНакладывает ограничение на денежную сумму (max) по операциям текущего терминала в заданный период (period).\nОграничение может накладываться как на операции зачисления (refund = false), так и на\nоперации возврата (refund = true).\n","required":["period","max","current","refund","currency"],"allOf":[{"$ref":"#/components/schemas/TerminalLimit"},{"properties":{"period":{"$ref":"#/components/schemas/TerminalLimitPeriod"},"max":{"type":"number","description":"Максимально допустимая денежная сумма для проведения по терминалу за заданный период."},"current":{"type":"number","description":"Текущая денежная сумма уже проведённая по терминалу в заданный период."},"refund":{"type":"boolean","description":"true - лимит накладывается только на операции возвратов\nfalse - лимит накладывается только на операции зачисления\n"},"currency":{"type":"string","description":"Трехсимвольный код валюты лимита (ISO 4217)."}}}]},"CountTerminalLimit":{"type":"object","description":"Лимит для терминала на количество операций.\n\nНакладывает ограничение на количество операций (max) по текущему терминалу в заданный период (period).\n","required":["period","max","current"],"allOf":[{"$ref":"#/components/schemas/TerminalLimit"},{"properties":{"period":{"$ref":"#/components/schemas/TerminalLimitPeriod"},"max":{"type":"integer","format":"int64","description":"Максимально допустимое количество операций для проведения по терминалу за заданный период."},"current":{"type":"integer","format":"int64","description":"Текущее количество уже проведённых по терминалу операций в заданный период."}}}]},"RegionTerminalLimit":{"type":"object","description":"Лимит для терминала на банковские карты заданного региона.\n\nНакладывает ограничение на операции, проводимые банковскими картами, выпущенными заданным регионом (region).\nОграничение может быть как разрешающим (allow = true), так и запрещающим (allow = false) проводить операции на \nтекущем терминале.\n","required":["allow","region"],"allOf":[{"$ref":"#/components/schemas/TerminalLimit"},{"properties":{"allow":{"type":"boolean","description":"true - РАЗРЕШАЕТ проводить операции банковскими картами, выпущенными в заданном регионе\nfalse - ЗАПРЕЩАЕТ проводить операции банковскими картами, выпущенными в заданном регионе\n"},"region":{"type":"string","description":"Регион для банковских карт которого действует ограничение."}}}]},"TerminalLimitPeriod":{"type":"string","description":"Период на который распространяется действие лимита.\n- DAY - день (лимит накладывает ограничения на текущий день)\n- MONTH - месяц (лимит накладывает ограничения на текущий месяц)\n","enum":["DAY","MONTH"]},"FeedbackOrder":{"type":"object","description":"Заявка на предоставление обратной связи для консультации по подключению Эквайринга.\n","required":["contactName","contactPhone","subject"],"properties":{"contactName":{"type":"string","description":"ФИО контактного лица.","pattern":"^[A-Za-zА-Яа-яІЎЁёіў\\-‘'’ ]+$","maxLength":100},"contactPhone":{"type":"string","description":"Номер телефона контактного лица.","pattern":"^\\+375\\d{9}$"},"subject":{"$ref":"#/components/schemas/FeedbackSubject"}}},"FeedbackSubject":{"type":"string","description":"Тема консультации по подключению Эквайринга.\n- TERMINAL_POS - Подключение Торгового Эквайринга с терминалом TerminalType = POS.\n- TERMINAL_KASSA - Подключение Торгового Эквайринга с терминалом TerminalType = KASSA.\n- TERMINAL_SOFT - Подключение Торгового Эквайринга с терминалом TerminalType = SOFT.\n- SITE - Разработка банком сайта для продаж, с подключенным Интернет Эквайрингом.\n- OTHER - Используется в случае, если существующие темы консультации не подходят.\n","enum":["TERMINAL_POS","TERMINAL_KASSA","TERMINAL_SOFT","SITE","OTHER"]},"LogEvent":{"type":"object","description":"Событие логгирования.","required":["logger","level","message"],"properties":{"logger":{"type":"string","description":"Наименование логгера."},"level":{"$ref":"#/components/schemas/LogLevel"},"message":{"type":"string","description":"Сообщение с описанием события."},"stacktrace":{"type":"string","description":"Трассировка стэка."}}},"LogLevel":{"type":"string","description":"Уровень события логгирования. \n- TRACE - событие отладки (высокая детализация)\n- DEBUG - событие отладки (обычная детализация)\n- INFO - информационное событие\n- WARN - предупреждающее событие\n- ERROR - событие-ошибка\n","enum":["TRACE","DEBUG","INFO","WARN","ERROR"]},"RtpInvoiceFormResponse":{"type":"object","description":"Данные для предзаполнения формы создания RTP инвойса.","properties":{"orderNumber":{"type":"string","description":"Номер заказа для организации в формате RTP-UUID."},"rtpAccounts":{"type":"array","description":"Список активных RTP счетов организации.","items":{"$ref":"#/components/schemas/Account"}}}},"RtpInvoiceDto":{"type":"object","description":"RTP инвойс. Счет выставляет торговец (организация) своему покупателю (физ. лицу).","required":["id","paymentCode","createTimestamp","expirationTimestamp","merchantOrderId","amount","currency","rtpAccountId"],"properties":{"id":{"type":"string","description":"Уникальный идентификатор RTP инвойса."},"paymentCode":{"type":"integer","description":"Код платежа (payment code), используется для идентификации типа платежа."},"createTimestamp":{"type":"string","format":"date-time","description":"Дата формирования (отметка времени создания)."},"expirationTimestamp":{"type":"string","format":"date-time","description":"Срок оплаты (оплатить до…)."},"merchantOrderId":{"type":"string","description":"Номер заказа.","maxLength":32},"amount":{"type":"number","format":"decimal","description":"Сумма."},"currency":{"type":"string","description":"Валюта ISO 4217 (трехбуквенный код)."},"status":{"$ref":"#/components/schemas/RtpInvoiceStatus"},"description":{"type":"string","description":"Описание заказа.","maxLength":598},"rtpAccountId":{"type":"string","description":"Счёт для зачисления (идентификатор RTP-счёта организации)."},"version":{"type":"string","description":"Версия."},"supplierId":{"type":"integer","description":"Идентификатор поставщика."},"terminalCode":{"type":"string","description":"Код терминала."},"externalErrorCode":{"type":"integer","description":"Код ошибки (0 = ок, !=0 ошибка)."},"externalErrorText":{"type":"string","description":"Текст ошибки.","maxLength":250},"externalInvoiceId":{"type":"string","description":"Идентификатор инвойса в ПС «RtP QR»."},"qrCode":{"type":"string","description":"Строка QR-кода.","maxLength":1000}}},"RtpInvoiceStatus":{"type":"string","description":"Статус RTP инвойса.\n- CREATED - Сформирован\n","enum":["CREATED"]},"InvoiceFormDataResponse":{"type":"object","description":"Данные для формы создания инвойса.","required":["orderId"],"properties":{"orderId":{"type":"string","description":"Сгенерированный номер заказа в формате PAY-{tid}-{create_timestamp}.","example":"PAY-23071452-20260202144500"}}}},"parameters":{"StatementCriteriaParameter":{"in":"query","name":"criteria","required":true,"description":"Критерий выборки транзакций для выписки.","schema":{"$ref":"#/components/schemas/StatementCriteria"},"example":"account=BY99ALFA30241512345678000001&types[0]=CREDIT&dateRangeProperty=CREATE&dateRange.name=TODAY"},"TransactionSortParameter":{"in":"query","name":"sort","required":true,"description":"Спецификация сортировки возвращаемых транзакций.\nTransactionSortProperty - перечисление свойств по которым возможна сортировка транзакций.\n","schema":{"$ref":"#/components/schemas/Sort"},"example":"properties[0].property=CREATE_TIMESTAMP&properties[0].order=ASC"},"PageParameter":{"in":"query","name":"page","required":true,"description":"Параметры постраничной навигации.","schema":{"$ref":"#/components/schemas/Page"},"example":"offset=0&count=20"},"InvoiceSortParameter":{"in":"query","name":"sort","required":true,"description":"Спецификация сортировки возвращаемых счетов на оплату.\nInvoiceSortProperty - перечисление свойств по которым возможна сортировка счетов на оплату.\n","schema":{"$ref":"#/components/schemas/Sort"},"example":"properties[0].property=CREATE_TIMESTAMP&properties[0].order=ASC"},"RtpInvoiceSortParameter":{"in":"query","name":"sort","required":true,"description":"Спецификация сортировки возвращаемых RTP-инвойсов.\nRtpInvoiceSortProperty - перечисление свойств по которым возможна сортировка RTP-инвойсов.\n","schema":{"$ref":"#/components/schemas/Sort"},"example":"properties[0].property=CREATE_TIMESTAMP&properties[0].order=ASC"}},"responses":{"ObjectCreatedResponse":{"description":"Ответ используется в качестве успешного ответа для всех запросов создания сущностей.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectCreatedResponse"}}}},"ValidationErrorResponse":{"description":"Ответ-ошибка валидации входных данных.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"PreconditionsCheckResponse":{"description":"Ответ используется при невыполнении правила из предусловий.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionsCheckException"}}}},"InvoiceFormDataResponse":{"description":"Ответ содержит данные для формы создания инвойса.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceFormDataResponse"}}}},"default":{"description":"Непредвиденная ошибка.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Exception"}}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"},"default":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://ibapi.alfabank.by:8273/authorize","scopes":{"private_acquiring_partner":"private_acquiring_partner","read_acquiring_partner":"read_acquiring_partner","create_acquiring_partner":"create_acquiring_partner","product_acquiring_partner":"product_acquiring_partner","internal_acquiring_partner":"internal_acquiring_partner"}}}}}},"x-wso2-security":{"apim":{"x-wso2-scopes":[{"name":"private_acquiring_partner","key":"private_acquiring_partner","roles":"private_production"},{"name":"read_acquiring_partner","key":"read_acquiring_partner","roles":"private_production, partner_production_personal, partner_production_info"},{"name":"create_acquiring_partner","key":"create_acquiring_partner","roles":"private_production, partner_production_personal, partner_production_create"},{"name":"product_acquiring_partner","key":"product_acquiring_partner","roles":"private_production, partner_production_personal, partner_production_product"},{"name":"internal_acquiring_partner","key":"internal_acquiring_partner","roles":"internal"}]}}}