2.0info: 1.4.0 foundation description: Serviço base do banking x-senior-domain: Domínio base do banking x-senior-domain-path: erpx_bnk x-senior-service-path: foundation contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_bnksecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /foundation/queries/healthcheck: post: description: Query for health check – SRE tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/listServiceStatusReceivable: post: description: API responsável pelo retorno se o cliente possui a conta bancária implantada no banking\n### Resources\n- res : //senior.com.br/erpx_bnk/foundation/queries/listServiceStatusReceivable tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/recFilterListServiceStatusReceivable description: Filtro responses: 200: description: Ok schema: type: object properties: serviceAvailable: type: array items: type: object allOf: – #/definitions/recServiceReceivable description: Serviços disponíveis 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /foundation/queries/getCredenciaisESales: post: description: Primitiva responsável por retornar as credenciais para a autenticação da API da eSales tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – producaoHabilitada properties: clientId: type: string maxLength: 255 description: ClientId clientSecret: type: string maxLength: 255 description: ClientSecret producaoHabilitada: type: boolean description: Indicativo se está habilitado a chamada para os endpoints de produção 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva responsável por retornar as credenciais para a autenticação da API da eSales tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – producaoHabilitada properties: clientId: type: string maxLength: 255 description: ClientId clientSecret: type: string maxLength: 255 description: ClientSecret producaoHabilitada: type: boolean description: Indicativo se está habilitado a chamada para os endpoints de produção 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumServiceType: description: Tipo de serviço de cobrança type: string enum: – PIX_QRCODE enumTipoServico: description: Tipo de serviço de cobrança type: string enum: – PIX_QRCODE enumStatusApi: description: Situação do serviço type: string enum: – ACTIVE – INACTIVE – NOT_DEPLOYED enumStatus: description: Situação do serviço type: string enum: – ATIVO – INATIVO – NAO_IMPLANTADO enumReceivableBank: description: Enumeration de bancos de recebimento type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO enumBancoRecebimento: description: Enumeration de bancos de recebimento type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recServiceReceivable: description: Serviço e situação type: object required: – status – serviceType – receivableBank – branchNumber – branchDigit – accountNumber – accountDigit properties: status: type: string allOf: – #/definitions/enumStatusApi description: Status serviceType: type: string allOf: – #/definitions/enumServiceType description: Tipo de serviço pixKey: type: string maxLength: 255 description: Chave pix receivableBank: type: string allOf: – #/definitions/enumReceivableBank description: Banco do recebimento branchNumber: type: integer format: int64 description: Número da agência minimum: 0 maximum: 99999 branchDigit: type: string maxLength: 2 description: Dígito da agência accountNumber: type: integer format: int64 description: Número da conta minimum: 0 maximum: 999999999999 accountDigit: type: string maxLength: 2 description: Dígito da conta recFilterListServiceStatusReceivable: description: Record com os filtros disponíveis para consulta de serviços disponíveis para a cobrança type: object required: – documentNumber properties: documentNumber: type: string maxLength: 14 description: Documento do recebedor serviceType: type: string allOf: – #/definitions/enumServiceType description: Tipo de serviço pixKey: type: string maxLength: 255 description: Chave pix receivableBank: type: string allOf: – #/definitions/enumReceivableBank description: Banco do recebimento branchNumber: type: integer format: int64 description: Número da agência minimum: 0 maximum: 99999 branchDigit: type: string maxLength: 2 description: Dígito da agência accountNumber: type: integer format: int64 description: Número da conta minimum: 0 maximum: 999999999999 accountDigit: type: string maxLength: 2 description: Dígito da conta notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE