openapi: 3.2.0 info: title: Raiffeisen Ru Client API version: 1.0.0 description: 'Operations tagged Client across 2 of this provider''s published API definitions: raiffeisen-ru-payment-control-openapi.yml, raiffeisen-ru-payment-control-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.raiffeisen.ru/pay-control tags: - description: Клиенты name: Client paths: /v1/clients: get: description: Метод получение списка клиентов по фильтрам operationId: getClients parameters: - description: Клиентский номер examples: oneCnum: summary: Пример с одним клиентский номером value: - AAAAAA multipleCnums: summary: Пример с несколькими клиентскими номерами value: - AAAAAA - BBBBBB in: query name: cnums required: false schema: example: - AAAAAA items: example: AAAAAA type: string type: array - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Один клиент value: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 schema: $ref: '#/components/schemas/ClientList' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение списка клиентов по фильтрам tags: - Client post: description: Для заключение договора по управлению дебиторской задолженности нужно зарегистрироваться и пройти проверки operationId: createClient requestBody: content: application/json: examples: simple: summary: Запрос на создание клиента value: cnum: AAAAAA accountNumber: '40916819105000006497' email: foobar@mail.ru schema: $ref: '#/components/schemas/CreateClientRequest' description: Параметры для регистрации required: true responses: '200': content: application/json: examples: simple: summary: Успешно создан value: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 schema: $ref: '#/components/schemas/Client' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Создание клиента tags: - Client parameters: - $ref: '#/components/parameters/AuthorizationHeader' - $ref: '#/components/parameters/IdTokenHeader' servers: - url: https://api.raiffeisen.ru/pay-control /v1/clients/{clientId}: get: description: Метод получения клиента по идентификатору operationId: getClientById parameters: - description: Идентификатор клиента in: path name: clientId required: true schema: example: 76b44414-8259-4a09-b4dd-dbe33e0a1729 format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Клиент value: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 schema: $ref: '#/components/schemas/Client' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение клиента по идентификатору tags: - Client servers: - url: https://api.raiffeisen.ru/pay-control /v1/clients/{cnum}/accounts: get: description: Метод получения списка доступных счетов клиента operationId: getClientAccountInfo parameters: - description: Клиентский номер examples: oneCnum: value: AAAAAA in: path name: cnum required: true schema: example: AAAAAA type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' responses: '200': content: application/json: examples: simple: summary: Один клиент value: - cbaNumber: '40916819105000006497' schema: $ref: '#/components/schemas/AccountInfoList' description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Получение списка доступных счетов клиента tags: - Client servers: - url: https://api.raiffeisen.ru/pay-control /v1/clients/{clientId}/contacts/{contactId}: patch: description: Метод обновление контакта клиента operationId: patchClientContact parameters: - description: Идентификатор клиента in: path name: clientId required: true schema: example: bf1d1868-a98e-4ae5-976f-0c4e21e0d510 format: uuid type: string - description: Идентификатор контакта in: path name: contactId required: true schema: example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string - $ref: '#/components/parameters/IdTokenHeader' - $ref: '#/components/parameters/AuthorizationHeader' requestBody: content: application/json: examples: simple: summary: Новые реквизиты контакта value: email: foobar@mail.ru cqrsVersion: 111111 schema: $ref: '#/components/schemas/PatchContactRequest' description: Новый контакт required: true responses: '200': description: OK '400': content: application/json: examples: simple: value: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 schema: $ref: '#/components/schemas/ErrorResponse' description: BAD_REQUEST '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/InternalError' summary: Обновление контакта клиента tags: - Client servers: - url: https://api.raiffeisen.ru/pay-control components: schemas: RestErrorCodes: description: '| code | description | |-----------------|------------------------------------------------------------------| | REST_ERROR_5001 | General service error | | REST_ERROR_5002 | Current CQRS version is different | | REST_ERROR_0001 | inn not valid | | REST_ERROR_0002 | ogrn not valid | | REST_ERROR_0003 | okved not valid | | REST_ERROR_0004 | opf not valid | | REST_ERROR_0005 | fullNameRus not valid | | REST_ERROR_0006 | shortNameRus not valid | | REST_ERROR_0007 | fullNameEn not valid | | REST_ERROR_0008 | shortNameEn not valid | | REST_ERROR_0009 | address not valid | | REST_ERROR_0010 | you can`t use product | | REST_ERROR_0011 | buyer already exists | | REST_ERROR_0012 | can''t fetched buyer requisites from DaData | | REST_ERROR_0013 | can''t find data for buyer requisites | | REST_ERROR_0014 | client not valid | | REST_ERROR_0015 | agreement not valid | | REST_ERROR_0016 | buyer not valid | | REST_ERROR_0017 | condition with contract number and date already exists | | REST_ERROR_0018 | for the PRO tariff, at least one contact must be fully filled in | | REST_ERROR_0019 | for the PRO newTariff, payment period must be filled | | REST_ERROR_0020 | for the PRO newTariff, payment period must be less then max | | REST_ERROR_0021 | contract date must be after then current date | | REST_ERROR_0022 | agreement already exists for client | | REST_ERROR_0023 | condition with current contract number and date already exist | | REST_ERROR_1000 | Unexpected error. Call to support team - paycontrol.support@raiffeisen.ru. | | REST_ERROR_1001 | File contains viruses | | REST_ERROR_1002 | Incorrect file format | | REST_ERROR_1003 | Supplies number exceeds limit | | REST_ERROR_1004 | The file size exceeds 1 MB | | REST_ERROR_1005 | Invalid cell type (row %d, column %d) | | REST_ERROR_1006 | Incorrect number of columns, expected: %d, found: %d | | REST_ERROR_1007 | Invalid header, expected: %s, found: %s | | REST_ERROR_1008 | INN must contain 10 or 12 digits | | REST_ERROR_1009 | INN cannot be empty | | REST_ERROR_1010 | contract number cannot be empty | | REST_ERROR_1011 | contract date cannot be empty | | REST_ERROR_1012 | primary document number is empty | | REST_ERROR_1013 | primary document date is empty | | REST_ERROR_1014 | Supply sum cannot be empty | | REST_ERROR_1015 | Invalid KPP | | REST_ERROR_1016 | payment date is empty | | REST_ERROR_1017 | payment date is not found in calendar | | REST_ERROR_1018 | Supply already exists in file | | REST_ERROR_1019 | Date cannot be in the future: supply date | | REST_ERROR_1020 | Date cannot be in the future: additional document date | | REST_ERROR_1021 | File is empty | | REST_ERROR_2000 | Supply with this number/date already exists | | REST_ERROR_2001 | payment date must be later than contract date | | REST_ERROR_2002 | payment date must be later than the primary document date | | REST_ERROR_2003 | primary document date cannot be earlier than contract date | | REST_ERROR_2004 | additional document date cannot be earlier than contract date | | REST_ERROR_2005 | Supply amount cannot be less than payment amount | | REST_ERROR_3000 | Posting amount cannot be more than remaining amount | | REST_ERROR_3001 | Debt sum cannot be less than posting amount | | REST_ERROR_3002 | Supply already repaid | | REST_ERROR_4000 | Out payment order already exists for incoming payment | | REST_ERROR_4001 | Remaining amount must be equal zero | ' enum: - REST_ERROR_5001 - REST_ERROR_1000 - REST_ERROR_1001 - REST_ERROR_1002 - REST_ERROR_1003 - REST_ERROR_1004 - REST_ERROR_1005 - REST_ERROR_1006 - REST_ERROR_1007 - REST_ERROR_1008 - REST_ERROR_1009 - REST_ERROR_1010 - REST_ERROR_1011 - REST_ERROR_1012 - REST_ERROR_1013 - REST_ERROR_1014 - REST_ERROR_1015 - REST_ERROR_1016 - REST_ERROR_1017 - REST_ERROR_1018 - REST_ERROR_1019 - REST_ERROR_1020 - REST_ERROR_1021 - REST_ERROR_2000 - REST_ERROR_2001 - REST_ERROR_2002 - REST_ERROR_2003 - REST_ERROR_2004 - REST_ERROR_2005 example: REST_ERROR_5001 type: string ErrorMessage: properties: code: $ref: '#/components/schemas/RestErrorCodes' description: description: Сообщение example: General service error type: string traceId: description: traceId example: 29bda8ca-4d33-11ec-81d3-0242ac130000 type: string required: - code - description type: object Client: description: Клиент example: id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: CREATED cqrsVersion: -1628796591 requisites: fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка fullNameEn: Joint-stock company Romashka shortNameEn: JSC Romashka inn: '1234567890' ogrn: '123456789012345' okved: '11.11' cnum: AAAAAA opf: OOO address: address state: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED cqrsVersion: -1628796591 properties: id: description: Идентификатор клиента example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string createdAt: description: Дата и время создания example: '2025-07-10T06:53:37.433211' pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string contacts: description: Контакты example: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 items: $ref: '#/components/schemas/Contact' type: array requisites: $ref: '#/components/schemas/OrganizationRequisites' state: $ref: '#/components/schemas/ClientState' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - contacts - cqrsVersion - createdAt - id - requisites - state type: object ContactStatus: description: Статус контакта enum: - CREATED example: CREATED type: string ErrorResponse: example: - code: REST_ERROR_5001 description: General service error traceId: 29bda8ca-4d33-11ec-81d3-0242ac130000 items: $ref: '#/components/schemas/ErrorMessage' type: array Error: properties: code: $ref: '#/components/schemas/ErrorCodes' description: description: Сообщение example: General service error type: string required: - code - description type: object Contact: description: Контакт properties: id: description: Идентификатор контакта example: 2c44306f-fc96-4780-9b37-6447273b190e format: uuid type: string createdAt: description: Дата и время создания example: '2025-07-10T06:53:37.433211' pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string email: description: Email example: foobar@mail.ru format: email type: string state: $ref: '#/components/schemas/ContactState' cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - cqrsVersion - createdAt - email - id - state type: object ClientList: example: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' requisites: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' contacts: - id: 2c44306f-fc96-4780-9b37-6447273b190e createdAt: '2025-07-10T06:53:37.433211' email: foobar@mail.ru state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: CREATED cqrsVersion: -1628796591 state: statusDate: '2021-07-10T06:53:37.433111' errors: [] status: APPROVED cqrsVersion: -1628796591 items: $ref: '#/components/schemas/Client' type: array OrganizationRequisites: description: Реквизиты организации example: ogrn: '123456789012345' fullNameRus: Акционерное общество Ромашка shortNameRus: АО Ромашка address: address opf: opf inn: '1234567890' kpp: '123456789' shortNameEn: АО Ромашка cnum: AAAAAA fullNameEn: Акционерное общество Ромашка okved: '11.11' properties: fullNameRus: description: Полное наименование example: Акционерное общество Ромашка type: string shortNameRus: description: Краткое наименование example: АО Ромашка type: string fullNameEn: description: Полное наименование на английском языке example: Акционерное общество Ромашка type: string shortNameEn: description: Краткое наименование на английском языке example: АО Ромашка type: string inn: description: ИНН example: '1234567890' maxLength: 12 minLength: 10 type: string ogrn: description: ОГРН example: '123456789012345' maxLength: 15 minLength: 13 type: string kpp: description: КПП example: '123456789' maxLength: 9 minLength: 9 type: string okved: description: ОКВЭД example: '11.11' type: string cnum: description: Клиентский номер example: AAAAAA maxLength: 6 minLength: 6 type: string opf: description: Организационно правовая форма example: OOO type: string address: description: Адрес example: address type: string required: - address - cnum - fullNameEn - fullNameRus - inn - ogrn - okved - opf - shortNameEn - shortNameRus type: object ClientState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/ClientStatus' description: Состояние клиента example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: APPROVED type: object ClientStatus: description: Статус клиента enum: - SENT_TO_CHECK - APPROVED - REJECTED type: string AccountInfo: description: Счет properties: cbaNumber: description: Номер счета example: '40916819105000006497' type: string required: - cbaNumber type: object PatchContactRequest: description: Обновление контакта клиента example: cqrsVersion: -1628796591 email: foobar@mail.ru properties: email: description: Email example: foobar@mail.ru format: email type: string cqrsVersion: description: hashCode от state - состояния объекта example: -1628796591 type: integer required: - cqrsVersion - email type: object ContactState: allOf: - $ref: '#/components/schemas/State' - properties: status: $ref: '#/components/schemas/ContactStatus' description: Состояние контакта example: statusDate: '2025-07-10T06:53:37.433211' errors: [] status: CREATED type: object ErrorCodes: description: '| code | description | |------------|--------------------------------------------------------------| | ERROR_2000 | General service error | | ERROR_2001 | Buyer not found | | ERROR_2002 | Condition not found | | ERROR_2003 | Duplicate supply | | ERROR_2004 | Payment date must be after then current date | | ERROR_2005 | Main document date must be after or equal then contract date | | ERROR_2006 | Buyer not valid | | ERROR_2007 | Additional document date must be after or equal then contract date | ' enum: - ERROR_2000 - ERROR_2001 - ERROR_2002 - ERROR_2003 - ERROR_2004 - ERROR_2005 - ERROR_2006 - ERROR_2007 example: ERROR_2000 type: string AccountInfoList: example: - cbaNumber: '40916819105000006497' items: $ref: '#/components/schemas/AccountInfo' type: array State: description: Состояние объекта properties: statusDate: description: yyyy-MM-dd'T'HH:mm:ss.SSSSSS format: date-time pattern: ([0-9]{4})-(?:[0-9]{2})-([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{6}) type: string errors: description: Ошибки items: $ref: '#/components/schemas/Error' type: array required: - statusDate type: object CreateClientRequest: example: accountNumber: '47422810900000405689' cnum: AAAAAA email: foobar@mail.ru properties: cnum: description: Клиентский номер example: AAAAAA type: string email: description: Email клиента example: foobar@mail.ru type: string accountNumber: description: ЦБ номер счета для списания комиссии example: '47422810900000405689' type: string required: - accountNumber - cnum - email type: object parameters: AuthorizationHeader: name: Authorization in: header description: Токен доступа required: true schema: type: string format: byte example: Bearer QXV0aG9yaXphdGlvbiBIZWFkZXIgRm9yIFRlc3Rpbmc= IdTokenHeader: name: Id-Token in: header description: Идентификационный токен пользователя required: true schema: type: string format: byte example: SUQgVE9LRU4gRk9SIFRFU1RJTkc= responses: InternalError: description: Внутренняя ошибка Unauthorized: description: Аутентификация не пройдена x-refined-from: - raiffeisen-ru-payment-control-openapi.yml - raiffeisen-ru-payment-control-openapi.yml