cobranca

2.0info: 2.0.0 cobranca description: Serviço de fachada para o domínio de cobrança do banking x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: cobranca 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_cobsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /cobranca/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 /cobranca/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 /cobranca/queries/exportCobrancaDadosBoleto: 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 /cobranca/queries/exportCobrancaItemBoleto: 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 /cobranca/queries/exportCobrancaItemBoletoHistorico: 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 /cobranca/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 /cobranca/actions/retornoCobrancaESales: post: description: API responsável pelo retorno da criação do registros e pagamentos de cobrança assíncrona do parceiro eSales tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tipo – recebedor properties: tipo: type: string description: Tipo da cobrança loteId: type: string description: Identificador do lote recebedor: type: object allOf: – #/definitions/recRecebedorESalesRetorno description: Informações do recebedor cobrancas: type: array items: type: object allOf: – #/definitions/recCobrancaESalesRetorno description: Lista das cobranças responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/actions/retornoCobrancaBoletoBtg: post: description: API responsável pelo retorno da criação do registros de cobrança assíncrona do parceiro BTG tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – webhookId – event properties: webhookId: type: string description: ID do webhook no BTG event: type: string description: Evento publicado pelo BTG data: type: object allOf: – #/definitions/recCobrancaBtgRetorno description: Dados da cobrança responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/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 /cobranca/actions/importCobrancaDadosBoleto: 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 /cobranca/actions/importCobrancaItemBoleto: 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 /cobranca/actions/importCobrancaItemBoletoHistorico: 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 /cobranca/events/importCobrancaDadosBoletoEvent: 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 /cobranca/events/exportCobrancaDadosBoletoEvent: 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 /cobranca/events/importCobrancaItemBoletoEvent: 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 /cobranca/events/exportCobrancaItemBoletoEvent: 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 /cobranca/events/importCobrancaItemBoletoHistoricoEvent: 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 /cobranca/events/exportCobrancaItemBoletoHistoricoEvent: 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 /cobranca/entities/cobrancaDadosBoleto: 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/cobrancaDadosBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/entities/cobrancaItemBoleto: 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/cobrancaItemBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoHistoricos: 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/cobrancaItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistorico 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/cobrancaItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/cobrancaItemBoletoHistorico 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/cobrancaItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /cobranca/entities/cobrancaItemBoleto/{parentId}/cobrancaItemBoletoHistoricos/{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/editCobrancaItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/editCobrancaItemBoletoHistorico 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/cobrancaItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/cobrancaItemBoletoHistorico 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/cobrancaItemBoletoHistorico 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 enumStatusRegistroCobrancaRetornoESales: type: string enum: – ATIVA – CONCLUIDA – REMOVIDA_PELO_USUARIO_RECEBEDOR – REMOVIDA_PELO_PSP – EM_PROCESSAMENTO – NEGADA description: Status do registro da cobrança do retorno da eSales: * `ATIVA` – ATIVA * `CONCLUIDA` – CONCLUIDA * `REMOVIDA_PELO_USUARIO_RECEBEDOR` – REMOVIDA PELO USUARIO RECEBEDOR * `REMOVIDA_PELO_PSP` – REMOVIDA PELO PSP * `EM_PROCESSAMENTO` – Em processamento * `NEGADA` – Negada enumBancoRecebimento: type: string enum: – BANCO_DO_BRASIL – SANTANDER – CAIXA_ECONOMICA_FEDERAL – BRADESCO – ITAU – SICREDI – BTG_PACTUAL description: Enumeration dos bancos de recebimento: * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `SANTANDER` – Santander – 033 * `CAIXA_ECONOMICA_FEDERAL` – Caixa Econômica Federal – 104 * `BRADESCO` – Bradesco – 237 * `ITAU` – Itaú – 341 * `SICREDI` – Sicredi – 748 * `BTG_PACTUAL` – BTG Pactual – 208 enumStatusRegistroCobrancaRetornoBtg: type: string enum: – CREATED – FAILED – UPDATED – PAID – CANCELED – CANCEL_FAILED – RETURNED description: Status do registro da cobrança do retorno da BTG: * `CREATED` – CRIADO * `FAILED` – FALHA * `UPDATED` – ATUALIZADA * `PAID` – PAGO * `CANCELED` – CANCELADO * `CANCEL_FAILED` – FALHA NO CANCELAMENTO * `RETURNED` – ESTORNADO enumSituacaoCobrancaItem: type: string enum: – AGUARDANDO_COBRANCA – PROCESSANDO_ENVIO_COBRANCA – COBRANCA_ENVIADA – COBRANCA_COM_PROBLEMAS – COBRANCA_GERADA – COBRANCA_NEGADA – COBRANCA_PAGA – COBRANCA_INAPTA_PARA_PROCESSAMENTO – COBRANCA_INATIVADA – ERRO_INESPERADO – FALHA_NA_VALIDACAO description: Enumeration de situação da cobrança item: * `AGUARDANDO_COBRANCA` – Aguardando cobrança * `PROCESSANDO_ENVIO_COBRANCA` – Processando envio da cobrança * `COBRANCA_ENVIADA` – Cobrança enviada * `COBRANCA_COM_PROBLEMAS` – Cobrança com problemas * `COBRANCA_GERADA` – Cobrança gerada * `COBRANCA_NEGADA` – Cobrança negada * `COBRANCA_PAGA` – Cobrança paga * `COBRANCA_INAPTA_PARA_PROCESSAMENTO` – Cobrança inapta para processamento * `COBRANCA_INATIVADA` – Cobrança inativada * `ERRO_INESPERADO` – Erro inesperado * `FALHA_NA_VALIDACAO` – Falha na validação EnumTipoValorBtg: type: string enum: – PERCENTAGE – FIXED_VALUE – NOT_APPLICABLE description: Enumeration dos tipos de valor do BTG: * `PERCENTAGE` – Percentual * `FIXED_VALUE` – Valor fixo * `NOT_APPLICABLE` – Não aplicável enumTipoProtesto: type: string enum: – DIAS_CORRIDOS – DIAS_UTEIS – NAO_PROTESTAR description: Enumeration dos tipos de protestos: * `DIAS_CORRIDOS` – Dias corridos * `DIAS_UTEIS` – Dias úteis * `NAO_PROTESTAR` – Não protestar enumSituacaoCobrancaItemDetalhes: type: string enum: – COBRANCA_VALIDADA – PROCESSANDO_ENVIO_COBRANCA – COBRANCA_ENVIADA – COBRANCA_COM_PROBLEMAS – COBRANCA_GERADA – COBRANCA_NEGADA – COBRANCA_PAGA – FALHA_NA_VALIDACAO – PROCESSANDO_BAIXA_BOLETO – BOLETO_BAIXADO – BOLETO_NAO_BAIXADO – PROCESSANDO_ALTERACAO_VENCIMENTO – DATA_VENCIMENTO_ALTERADA – DATA_VENCIMENTO_NAO_ALTERADA – PROCESSANDO_PROTESTO – PROTESTADO – NAO_PROTESTADO – PROCESSANDO_SUSTACAO_PROTESTO – PROTESTO_SUSTADO – PROTESTO_NAO_SUSTADO – PROCESSANDO_ALTERACAO_VALOR – VALOR_ALTERADO – VALOR_NAO_ALTERADO – PROCESSANDO_ALTERACAO_JUROS – JUROS_ALTERADOS – JUROS_NAO_ALTERADOS – PROCESSANDO_ALTERACAO_MULTA – MULTA_ALTERADA – MULTA_NAO_ALTERADA – PROCESSANDO_ALTERACAO_DESCONTO – DESCONTO_ALTERADO – DESCONTO_NAO_ALTERADO – PROCESSANDO_CANCELAMENTO_BOLETO – BOLETO_CANCELADO – BOLETO_NAO_CANCELADO description: Enumeration de situação dos detalhes do cobrança item: * `COBRANCA_VALIDADA` – Cobrança validada * `PROCESSANDO_ENVIO_COBRANCA` – Processando envio da cobrança * `COBRANCA_ENVIADA` – Cobrança enviada * `COBRANCA_COM_PROBLEMAS` – Cobrança com problemas * `COBRANCA_GERADA` – Cobrança gerada * `COBRANCA_NEGADA` – Cobrança negada * `COBRANCA_PAGA` – Cobrança paga * `FALHA_NA_VALIDACAO` – Falha na validação * `PROCESSANDO_BAIXA_BOLETO` – Processando baixa do boleto * `BOLETO_BAIXADO` – Boleto baixado * `BOLETO_NAO_BAIXADO` – Boleto não baixado * `PROCESSANDO_ALTERACAO_VENCIMENTO` – Processando alteracao vencimento * `DATA_VENCIMENTO_ALTERADA` – Data de vencimento alterada * `DATA_VENCIMENTO_NAO_ALTERADA` – Data de vencimento não alterada * `PROCESSANDO_PROTESTO` – Processando protesto * `PROTESTADO` – Protestado * `NAO_PROTESTADO` – Não protestado * `PROCESSANDO_SUSTACAO_PROTESTO` – Processando sustação de protesto * `PROTESTO_SUSTADO` – Protesto sustado * `PROTESTO_NAO_SUSTADO` – Protesto não sustado * `PROCESSANDO_ALTERACAO_VALOR` – Processando alteracao de valor * `VALOR_ALTERADO` – Valor alterado * `VALOR_NAO_ALTERADO` – Valor não alterado * `PROCESSANDO_ALTERACAO_JUROS` – Processando alteracao de juros * `JUROS_ALTERADOS` – Juros alterados * `JUROS_NAO_ALTERADOS` – Juros não alterados * `PROCESSANDO_ALTERACAO_MULTA` – Processando alteracao de multa * `MULTA_ALTERADA` – Multa alterada * `MULTA_NAO_ALTERADA` – Multa não alterada * `PROCESSANDO_ALTERACAO_DESCONTO` – Processando alteracao desconto * `DESCONTO_ALTERADO` – Desconto alterada * `DESCONTO_NAO_ALTERADO` – Desconto não alterada * `PROCESSANDO_CANCELAMENTO_BOLETO` – Processando cancelamento de boleto * `BOLETO_CANCELADO` – Boleto cancelado * `BOLETO_NAO_CANCELADO` – Boleto não cancelado enumOrigemErro: type: string enum: – BANKING – PARCEIRO – BANCO description: Enumeration da origem do erro do título: * `BANKING` – Banking * `PARCEIRO` – Parceiro * `BANCO` – Banco 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 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 recRecebedorESalesRetorno: description: type: object required: – cnpj properties: cnpj: type: string description: CNPJ do recebedor convenio: type: string description: Convênio recCobrancaESalesRetorno: description: Record da cobrança pix que foi retornado pelo parceiro eSales type: object required: – txid properties: txid: type: string description: Identificador da cobrança status: type: string allOf: – #/definitions/enumStatusRegistroCobrancaRetornoESales description: Status do registro da cobranca pagamentos: type: array items: type: object allOf: – #/definitions/recPagamentoRetornoESales description: Informações sobre pagamentos registro: type: object allOf: – #/definitions/recRegistroRetornoESales description: Registro da cobrança boleto: type: object allOf: – #/definitions/recBoletoESalesRetorno description: Informações exclusivas do boleto recRegistroRetornoESales: description: Record do registro da cobrança que foi retornada pelo parceiro eSales type: object required: – calendario properties: calendario: type: object allOf: – #/definitions/recCalendarioRetornoESales description: tempo da cobrança retornada pelo parceiro pixCopiaECola: type: string description: Pix copia e cola problema: type: object allOf: – #/definitions/recProblemaRetornoCobrancaESales description: Problema imagemBase64: type: string maxLength: 2048 description: Pix QRCode recCalendarioRetornoESales: description: Record de informações referente ao controle de tempo da cobrança retornada pelo parceiro type: object properties: criacao: type: string format: date-time description: Data de criação recProblemaRetornoCobrancaESales: description: Record do problema da cobrança retornada pelo parceiro type: object properties: type: type: string description: Tipo de problema type: string description: Título do problema status: type: integer format: int64 description: Status do problema detail: type: string description: Detalhe do problema violacoes: type: array items: type: object allOf: – #/definitions/recAvisosRetornoCobrancaESales description: Violações recAvisosRetornoCobrancaESales: description: Record do aviso da cobrança retornada pelo parceiro type: object properties: razao: type: string description: Razão propriedade: type: string description: Propriedade valor: type: string description: Valor recPagamentoRetornoESales: description: Record com informações relacionadas ao pagamento eSales type: object required: – valor – tipo – horario properties: valor: type: string description: Valor pago tipo: type: string description: Tipo da cobranca horario: type: string format: date-time description: Data e hora do pagamento infoPagador: type: string description: Informações do pagador endToEndId: type: string description: Identificador único do pagamento componentesValor: type: object allOf: – #/definitions/recComponentesValorESales description: Informações detalhada dos valores do pagamento recComponentesValorESales: description: Record com informações relacionadas ao detalhamente do valor pago no título – eSales type: object properties: original: type: object allOf: – #/definitions/recValorESales description: Valor original multa: type: object allOf: – #/definitions/recValorESales description: Valor multa juros: type: object allOf: – #/definitions/recValorESales description: Valor juros abatimento: type: object allOf: – #/definitions/recValorESales description: Valor abatimento desconto: type: object allOf: – #/definitions/recValorESales description: Valor desconto recValorESales: description: Record com detalhamento do valor – eSales type: object properties: valor: type: string description: Valor recBoletoESalesRetorno: description: Record com as informações exclusivas do boleto type: object properties: seuNumero: type: string description: Seu número nossoNumero: type: string description: Nosso número linhaDigitavel: type: string description: Linha digitável ocorrencias: type: array items: type: object allOf: – #/definitions/recOcorrenciaESalesRetorno description: Lista de ocorrências dataLiquidacao: type: string format: date description: Data de liquidação dataVencimento: type: string format: date description: Data de vencimento protesto: type: object allOf: – #/definitions/recProtesto description: Informações de protesto recOcorrenciaESalesRetorno: description: Record com a informação da ocorrência type: object properties: codigo: type: string description: Código descricao: type: string description: Descrição recProtesto: description: Record com as informações de protesto type: object required: – tipo properties: tipo: type: string allOf: – #/definitions/enumTipoProtesto description: Tipo de protesto prazo: type: integer format: int64 description: Prazo recCobrancaBtgRetorno: description: Record da cobrança pix que foi retornado pelo parceiro BTG type: object required: – bankSlipId – amount – dueDate properties: bankSlipId: type: string description: Identificador da cobrança correlationId: type: string description: Identificador da correlação ourNumber: type: string description: Nosso número referenceNumber: type: string description: Seu número status: type: string allOf: – #/definitions/enumStatusRegistroCobrancaRetornoBtg description: Status do registro da cobranca barCode: type: string description: Código de barras digitableLine: type: string description: Linha digitável amount: type: string description: Valor da cobrança amountPaid: type: string description: Valor pago dueDate: type: string format: date description: Data de vencimento paidAt: type: string format: date description: Data de pagamento settledAt: type: string format: date-time description: Data de liberação payee: type: object allOf: – #/definitions/recBeneficiario description: Dados do beneficiario payer: type: object allOf: – #/definitions/recPagador description: Dados do pagador pixInfo: type: object allOf: – #/definitions/recPixInfo description: Dados do pix errors: type: array items: type: object allOf: – #/definitions/recError description: Erros na geração do boleto interests: type: object allOf: – #/definitions/recInterests description: Valores de Juros e Multa discounts: type: array items: type: object allOf: – #/definitions/recValueBtg description: Valores de desconto e abatimento recInterests: description: Dados de juros e multa do BTG type: object required: – arrears – penalty properties: arrears: type: object allOf: – #/definitions/recValueBtg description: Juros penalty: type: object allOf: – #/definitions/recValueBtg description: Multa recValueBtg: description: Dados de valores do BTG type: object required: – value – type properties: value: type: string description: Valor type: type: string allOf: – #/definitions/EnumTipoValorBtg description: Tipo de valor dueDate: type: string format: date-time description: Data de vencimento recBeneficiario: description: Dados do pagador da cobrança type: object properties: accountId: type: string description: Dados da conta taxId: type: string description: CNPJ bankCode: type: string description: Código do banco branchCode: type: string description: Agência number: type: string description: Número da conta recPagador: description: Dados do pagador da cobrança type: object required: – taxId properties: name: type: string description: Nome taxId: type: string description: Número do documento recError: description: Erros na geração do boleto type: object properties: code: type: string description: Código do erro descriptiom: type: string description: Descrição do erro recPixInfo: description: Dados do pix type: object properties: emv: type: string description: Pix copia e cola key: type: string description: Chave Pix txId: type: string description: Identificador da cobrança emvUrl: type: string description: Pix QRCode cobrancaDadosBoleto: description: Entidade de dados da cobrança de boleto type: object required: – id – loteId – bancoRecebimento properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Identificador do lote bancoRecebimento: type: string allOf: – #/definitions/enumBancoRecebimento description: Banco de recebimento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cobrancaItemBoleto: description: Entidade de dados do título de cobrança boleto type: object required: – txid – seuNumero – situacao properties: id: type: string format: uuid description: Identificador do registro txid: type: string description: Identificador utilizado para comunicação com o parceiro cobrancaDadosBoleto: type: object allOf: – #/definitions/cobrancaDadosBoleto description: Cobrança de dados boleto relacionada seuNumero: type: string maxLength: 25 description: Seu número situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItem description: Situação do título cobrancaItemBoletoHistoricos: type: array items: type: object allOf: – #/definitions/cobrancaItemBoletoHistorico description: Histórico de atualizações da situação do título usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: cobrancaItemBoletoHistorico: description: Entidade de histórico do título de cobrança boleto type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro cobrancaItemBoleto: type: object allOf: – #/definitions/cobrancaItemBoleto description: Registro da cobrança item boleto situacao: type: string allOf: – #/definitions/enumSituacaoCobrancaItemDetalhes description: Situação mensagem: type: string description: Mensagem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editCobrancaItemBoletoHistorico: type: object required: – id allOf: – #/definitions/cobrancaItemBoletoHistorico 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