Onboarding bancário (onboarding)

2.0info: 2.4.0 Onboarding bancário description: onboarding x-senior-domain: Domínio base do banking x-senior-domain-path: erpx_bnk x-senior-service-path: onboarding 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: /onboarding/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço 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 geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço 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 geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/buscarTokenAcessoBtg: post: description: Query para retornar o token de acesso do BTG por CNPJ tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ que foi feito o consentimento responses: 200: description: Ok schema: type: object required: – isProdEnabled properties: accessToken: type: string description: Access Token para acesso as APIs do BTG isProdEnabled: type: boolean description: Campo refente ao ambiente da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para retornar o token de acesso do BTG por CNPJ tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cnpj description: CNPJ que foi feito o consentimento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – isProdEnabled properties: accessToken: type: string description: Access Token para acesso as APIs do BTG isProdEnabled: type: boolean description: Campo refente ao ambiente da requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/getCredenciaisBtg: post: description: Primitiva responsável por retornar as credenciais para a autenticação da API do parceiro BTG PACTUAL 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 description: ClientId clientSecret: type: string 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 do parceiro BTG PACTUAL tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – producaoHabilitada properties: clientId: type: string description: ClientId clientSecret: type: string 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 /onboarding/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 description: ClientId clientSecret: type: string 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 description: ClientId clientSecret: type: string 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 /onboarding/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 /onboarding/queries/exportAutenticacaoBtg: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportAutenticacaoBtgHistorico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportAutenticacaoBtgEscopo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportAutenticacaoBtgWebhook: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportRefreshTokenBtgHistorico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportParceiroESales: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportClienteESales: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/queries/exportContaESales: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/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 /onboarding/actions/gerarUrlConsentimentoBtg: post: description: Action para gerar URL de redirecionamento para consentimento no BTG tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – escopos – cnpj properties: escopos: type: array items: type: string allOf: – #/definitions/enumEscopo minimum: 1 description: Escopos que serão consentidos cnpj: type: string description: CNPJ que será feito o consentimento responses: 200: description: Ok schema: type: object properties: url: type: string description: URL de consentimento no BTG 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/gerarAutenticacaoBtg: post: description: Action para iniciar autenticação com o banco BTG tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – authorizationCode – cnpj properties: authorizationCode: type: string description: Código de autorização do consentimento no BTG cnpj: type: string description: CNPJ que foi feito o consentimento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/cadastroClienteESales: post: description: Action para processamento do onboarding ESales tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parceiroESalesId – cnpj – nome properties: parceiroESalesId: type: string description: Id do parceiro ESales id: type: string description: Identificador do cliente ESales cnpj: type: string description: CNPJ do cliente nome: type: string description: Nome do cliente responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: string description: Retorno da ESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/cadastroContaESales: post: description: Action para cadastro de conta da ESales tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codigoBanco – numeroAgencia – numeroConta – clienteESalesId properties: id: type: string description: Identificador codigoBanco: type: string description: Código do banco numeroAgencia: type: string description: Número da agência digitoAgencia: type: string description: Dígito da agência numeroConta: type: string description: Número da conta digitoConta: type: string description: Dígito da conta clienteESalesId: type: string description: ID do cliente esales responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: string description: Retorno do cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/cadastroParceiroESales: post: description: Action para cadastrar Parceiro eSales tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpj – razaoSocial properties: cnpj: type: string description: CNPJ do Parceiro eSales razaoSocial: type: string description: Razão Social do Parceiro eSales responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: string description: Retorno do cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importAutenticacaoBtg: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importAutenticacaoBtgHistorico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importAutenticacaoBtgEscopo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importAutenticacaoBtgWebhook: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importRefreshTokenBtgHistorico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importParceiroESales: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importClienteESales: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/actions/importContaESales: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/signals/gerarAutenticacaoBtgAsync: post: description: Signal para gerar autenticação com o banco BTG tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: authorizationCode: type: string description: Código de autorização do consentimento no BTG autenticacaoBtgId: type: string description: Id do registro de autenticação com o BTG no banking responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/signals/refreshBtgToken: post: description: Sinal para atualizar o token de acesso as APIs do BTG tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – cnpj properties: cnpj: type: string description: CNPJ que foi feito o consentimento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/signals/gerarWebhookExternoBtg: post: description: Event para fazer a geração do webhook externo no BTG tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – webhooks properties: webhooks: type: array items: type: object allOf: – #/definitions/recWebhookBtg minimum: 1 description: Dados do webhook no banco BTG responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /onboarding/events/autenticacaoBtgFinalizada: post: description: Event para avisar como finalizou a autenticação com BTG x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: situacao: type: string allOf: – #/definitions/enumSituacaoAutenticacaoBtg description: Status da autenticação com BTG mensagemErro: type: string description: Mensagem em caso de erro na autenticação escopos: type: array items: type: string allOf: – #/definitions/enumEscopo description: Escopos consentidos cnpj: type: string description: CNPJ que foi feito o consentimento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAutenticacaoBtgEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAutenticacaoBtgEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAutenticacaoBtgHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAutenticacaoBtgHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAutenticacaoBtgEscopoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAutenticacaoBtgEscopoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importAutenticacaoBtgWebhookEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportAutenticacaoBtgWebhookEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importRefreshTokenBtgHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportRefreshTokenBtgHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importParceiroESalesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportParceiroESalesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importClienteESalesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportClienteESalesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/importContaESalesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/events/exportContaESalesEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtg: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/autenticacaoBtg 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtgHistorico: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/autenticacaoBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtg/{parentId}/autenticacaoBtgHistorico: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/autenticacaoBtgHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/autenticacaoBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/autenticacaoBtgHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/autenticacaoBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/autenticacaoBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtg/{parentId}/autenticacaoBtgHistorico/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAutenticacaoBtgHistorico responses: 200: description: Ok schema: #/definitions/editAutenticacaoBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/autenticacaoBtgHistorico responses: 200: description: Ok schema: #/definitions/autenticacaoBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/autenticacaoBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtgEscopo: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/autenticacaoBtgEscopo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtg/{parentId}/autenticacaoBtgEscopo: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/autenticacaoBtgEscopo responses: 200: description: The created resources schema: type: array items: #/definitions/autenticacaoBtgEscopo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/autenticacaoBtgEscopo responses: 200: description: The created resources schema: type: array items: #/definitions/autenticacaoBtgEscopo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/autenticacaoBtgEscopo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtg/{parentId}/autenticacaoBtgEscopo/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAutenticacaoBtgEscopo responses: 200: description: Ok schema: #/definitions/editAutenticacaoBtgEscopo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/autenticacaoBtgEscopo responses: 200: description: Ok schema: #/definitions/autenticacaoBtgEscopo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/autenticacaoBtgEscopo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtgWebhook: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/autenticacaoBtgWebhook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtgEscopo/{parentId}/autenticacaoBtgWebhook: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/autenticacaoBtgWebhook responses: 200: description: The created resources schema: type: array items: #/definitions/autenticacaoBtgWebhook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/autenticacaoBtgWebhook responses: 200: description: The created resources schema: type: array items: #/definitions/autenticacaoBtgWebhook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/autenticacaoBtgWebhook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtgEscopo/{parentId}/autenticacaoBtgWebhook/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAutenticacaoBtgWebhook responses: 200: description: Ok schema: #/definitions/editAutenticacaoBtgWebhook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/autenticacaoBtgWebhook responses: 200: description: Ok schema: #/definitions/autenticacaoBtgWebhook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/autenticacaoBtgWebhook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/refreshTokenBtgHistorico: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/refreshTokenBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtg/{parentId}/refreshTokenBtgHistorico: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/refreshTokenBtgHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/refreshTokenBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/refreshTokenBtgHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/refreshTokenBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/refreshTokenBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/autenticacaoBtg/{parentId}/refreshTokenBtgHistorico/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRefreshTokenBtgHistorico responses: 200: description: Ok schema: #/definitions/editRefreshTokenBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/refreshTokenBtgHistorico responses: 200: description: Ok schema: #/definitions/refreshTokenBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/refreshTokenBtgHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/parceiroESales: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/parceiroESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/clienteESales: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/clienteESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/parceiroESales/{parentId}/clientes: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/clienteESales responses: 200: description: The created resources schema: type: array items: #/definitions/clienteESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/clienteESales responses: 200: description: The created resources schema: type: array items: #/definitions/clienteESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/clienteESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/parceiroESales/{parentId}/clientes/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editClienteESales responses: 200: description: Ok schema: #/definitions/editClienteESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/clienteESales responses: 200: description: Ok schema: #/definitions/clienteESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/clienteESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/contaESales: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contaESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/clienteESales/{parentId}/contas: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/contaESales responses: 200: description: The created resources schema: type: array items: #/definitions/contaESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/contaESales responses: 200: description: The created resources schema: type: array items: #/definitions/contaESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/contaESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /onboarding/entities/clienteESales/{parentId}/contas/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editContaESales responses: 200: description: Ok schema: #/definitions/editContaESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contaESales responses: 200: description: Ok schema: #/definitions/contaESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contaESales 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumSituacaoConsentimentoBtg: type: string enum: – PROCESSANDO – ATIVO – ATIVO_COM_ALERTA – INATIVO description: Status da autenticação com BTG: * `PROCESSANDO` – Processando consentimento * `ATIVO` – Consentimento banco BTG ativo * `ATIVO_COM_ALERTA` – Consentimento banco BTG ativo com alerta * `INATIVO` – Consentimento banco BTG inativo enumSituacaoEscopoBtg: type: string enum: – ATIVO – INATIVO description: Status do escopo no banco BTG: * `ATIVO` – Escopo no banco BTG ativo * `INATIVO` – Escopo no banco BTG inativo enumSituacaoAutenticacaoBtg: type: string enum: – ERRO – SUCESSO description: Status da autenticação com BTG: * `ERRO` – Autenticação finalizada com ERRO * `SUCESSO` – Autenticação finalizada com SUCESSO enumEscopo: type: string enum: – COBRANCA_BOLETO – PAGAMENTO – SALDO – EXTRATO – RISCO_SACADO – DESCONTO_DUPLICATAS – ANTECIPACAO_CARTAO – DDA description: Escopos disponiveis no banco BTG: * `COBRANCA_BOLETO` – Cobrança por boleto * `PAGAMENTO` – Pagamento * `SALDO` – Saldo * `EXTRATO` – Extrato * `RISCO_SACADO` – Risco Sacado * `DESCONTO_DUPLICATAS` – Desconto de duplicatas * `ANTECIPACAO_CARTAO` – Antecipação de Cartão * `DDA` – Débito Direto Autorizado (DDA) 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 fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error recWebhookBtg: description: Dados para gerar webhook no banco BTG type: object properties: cnpj: type: string description: CNPJ eventos: type: array items: type: string description: Eventos do BTG descricao: type: string description: Descrição do webhook do BTG primitiva: type: string description: Primitiva do Banking webhookId: type: string description: Id do webhook no Banking escopo: type: string allOf: – #/definitions/enumEscopo description: Escopo 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 autenticacaoBtg: description: Autenticação banco BTG type: object required: – id – cnpj – situacao properties: id: type: string format: uuid description: Id do registro cnpj: type: string description: CNPJ consentido accessToken: type: string format: byte description: Access Token para acesso as APIs do BTG refreshToken: type: string format: byte description: Refresh Token para solicitação do Access Token situacao: type: string allOf: – #/definitions/enumSituacaoConsentimentoBtg description: Status do consentimento com BTG dataConsentimentoAtivo: type: string format: date-time description: Data e hora do último consentimento feito com sucesso autenticacaoBtgHistorico: type: array items: type: object allOf: – #/definitions/autenticacaoBtgHistorico description: Históricos de autenticações banco BTG autenticacaoBtgEscopo: type: array items: type: object allOf: – #/definitions/autenticacaoBtgEscopo description: Escopos consentido com banco BTG refreshTokenBtgHistorico: type: array items: type: object allOf: – #/definitions/refreshTokenBtgHistorico description: Histórico do processo de atualização do token de autenticação do banco BTG usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: autenticacaoBtgHistorico: description: Histórico de autenticações banco BTG type: object required: – id – situacao – dataConsentimento properties: id: type: string format: uuid description: Id do registro autenticacaoBtg: type: object allOf: – #/definitions/autenticacaoBtg description: Autenticação com BTG situacao: type: string allOf: – #/definitions/enumSituacaoAutenticacaoBtg description: Status da autenticação com BTG mensagemErro: type: string description: Mensagem em caso de erro na autenticação dataConsentimento: type: string format: date-time description: Data e hora da tentativa de consentimento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editAutenticacaoBtgHistorico: type: object required: – id allOf: – #/definitions/autenticacaoBtgHistorico autenticacaoBtgEscopo: description: Escopo consentido com banco BTG type: object required: – id – escopo properties: id: type: string format: uuid description: Id do registro escopo: type: string allOf: – #/definitions/enumEscopo description: Access Token para acesso as APIs do BTG autenticacaoBtg: type: object allOf: – #/definitions/autenticacaoBtg description: Autenticação com BTG autenticacaoBtgWebhook: type: array items: type: object allOf: – #/definitions/autenticacaoBtgWebhook description: Registros de webhook no banco BTG situacao: type: string allOf: – #/definitions/enumSituacaoEscopoBtg description: Situação do escopo usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editAutenticacaoBtgEscopo: type: object required: – id allOf: – #/definitions/autenticacaoBtgEscopo autenticacaoBtgWebhook: description: Registro de webhook no banco BTG type: object required: – id – webhookId properties: id: type: string format: uuid description: Id do registro webhookId: type: string description: Id do webhook no BTG autenticacaoBtgEscopo: type: object allOf: – #/definitions/autenticacaoBtgEscopo description: Escopo consentido com banco BTG usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editAutenticacaoBtgWebhook: type: object required: – id allOf: – #/definitions/autenticacaoBtgWebhook refreshTokenBtgHistorico: description: Histórico do processo de atualização do token de autenticação do banco BTG type: object required: – id – situacao – dataRefreshToken properties: id: type: string format: uuid description: Id do registro autenticacaoBtg: type: object allOf: – #/definitions/autenticacaoBtg description: Autenticação com BTG situacao: type: string allOf: – #/definitions/enumSituacaoAutenticacaoBtg description: Status do refreshToken realizado mensagemErro: type: string maxLength: 255 description: Mensagem em caso de erro no refreshToken dataRefreshToken: type: string format: date-time description: Data e hora da tentativa do refreshToken usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editRefreshTokenBtgHistorico: type: object required: – id allOf: – #/definitions/refreshTokenBtgHistorico parceiroESales: description: Parceiro eSales type: object required: – id – cnpj – razaoSocial – cobranca – pagamento properties: id: type: string format: uuid description: Id do registro cnpj: type: string description: CNPJ razaoSocial: type: string description: Razão Social cobranca: type: boolean description: Indica a situação de cobrança pagamento: type: boolean description: Indica a situação de pagamento clientId: type: string format: byte description: ClientID clientSecret: type: string format: byte description: ClientSecret clientes: type: array items: type: object allOf: – #/definitions/clienteESales description: Clientes eSales usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: clienteESales: description: Cliente eSales type: object required: – id – cnpj – nome properties: id: type: string format: uuid description: Id do registro parceiroESales: type: object allOf: – #/definitions/parceiroESales description: Parceiro eSales cnpj: type: string description: CNPJ nome: type: string description: Nome do cliente contas: type: array items: type: object allOf: – #/definitions/contaESales description: Contas eSales usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editClienteESales: type: object required: – id allOf: – #/definitions/clienteESales contaESales: description: Conta eSales type: object required: – id – codigoBanco – agencia – conta properties: id: type: string format: uuid description: Id do registro clienteESales: type: object allOf: – #/definitions/clienteESales description: Cliente eSales codigoBanco: type: string maxLength: 3 description: Código do Banco agencia: type: string description: Agência agenciaDigito: type: string description: Dígito da agência conta: type: string description: Conta contaDigito: type: string description: Dígito da conta usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editContaESales: type: object required: – id allOf: – #/definitions/contaESales 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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