2.0info: 1.7.0 financeiro description: Serviço para gerenciar os retornos dos parceiros de serviços financeiros do banking x-senior-domain: Domínio de serviços financeiros do banking x-senior-domain-path: erpx_bnk_fin x-senior-service-path: financeiro 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_bnk_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /financeiro/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 /financeiro/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 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string 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 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financeiro/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/genericError /financeiro/actions/retornoRiscoSacadoBtg: post: description: API responsável pelo retorno do Risco Sacado do parceiro BTG tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – webhookId – event – data properties: webhookId: type: string description: Id do webhook event: type: string description: Nome do evento data: type: object allOf: – #/definitions/recBtgReceivableStatus description: Informações do título responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financeiro/actions/retornoDescontoDuplicatasBtg: post: description: API responsável pelo retorno do Desconto Duplicatas do parceiro BTG tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – webhookId – event – data properties: webhookId: type: string description: Id do webhook event: type: string description: Nome do evento data: type: object allOf: – #/definitions/recBtgReceivableStatus description: Informações do título responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /financeiro/actions/retornoAntecipacaoCartaoBtg: post: description: API responsável por processar o retorno da antecipação de recebíveis cartão de crédito do BTG tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – webhookId – event – data properties: webhookId: type: string description: Id do webhook event: type: string description: Nome do evento data: type: object allOf: – #/definitions/recReceivableCreditCardUpdate description: Dados do status do recebível responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recBtgReceivableStatus: description: Retorno de status do título Risco Sacado type: object required: – id – identification – maturityDate – status – payerTaxId – payeeTaxId – eventTimestamp – borderoTrackingId properties: id: type: string description: Id de controle do BTG identification: type: string description: Numero de identificacao do título no BTG (numero do titulo) trades: type: array items: type: object allOf: – #/definitions/btgReceivableStatusTrades description: Outras negociações maturityDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de vencimento do título status: type: string description: Status do processamento do título payerTaxId: type: string description: Documento do pagador payeeTaxId: type: string description: Documento do favorecido motivos: type: array items: type: string description: Justificativas conforme status recebido invoiceIdentification: type: string description: Identificação da transferência realizada ao favorecido em caso de Antecipação nettedPaymentIdentification: type: string description: Autenticação mecânica da transferência realizada ao favorecido em caso de Antecipação eventTimestamp: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data do evento originId: type: string description: Id do título borderoTrackingId: type: string description: Identificador de rastreio do processo maturityAmount: type: string description: Valor do titulo simulatedDisbursementAmount: type: string description: Valor a antecipar productPortfolio: type: string description: Produto btgReceivableStatusTrades: description: Outras negociações type: object properties: id: type: string description: Identificador da negociação contractNumber: type: string description: Número do contrato de negociação operationId: type: integer format: int64 description: Id da operação recReceivableCreditCardUpdate: description: Record com os dados do status do recebível type: object required: – receivable – disbursementAmount – registeredAmount properties: receivable: type: object allOf: – #/definitions/recCreditCardReceivable description: Dados do recebível disbursementAmount: type: string description: Valor máximo do recebível descontado da taxa de operação acordada registeredAmount: type: string description: Valor do recebível que foi possível ser registrado na Registradora recCreditCardReceivable: description: Record com os dados do recebível type: object required: – id – payeeId – payerId – maturityDate – scheme – maturityAmount – status properties: id: type: integer format: int64 description: Identificador do recebível payeeId: type: string description: CNPJ do estabelecimento comercial payerId: type: string description: Credenciadora/Maquininha de cartão de crédito maturityDate: type: string format: date description: Data de vencimento do recebível seguindo a norma ISO-8601 scheme: type: string description: Bandeira do cartão de crédito maturityAmount: type: string description: Valor máximo do recebível disponível para antecipar status: type: string description: Estado do recebível 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 description: Class of notification notificationOrigin: type: string 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 description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string 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 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string 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 description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage