2.0info: 2.14.2 Cobrança Boleto description: Serviço de cobranças via Boleto x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: boleto contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx_bnk_cob/boletosecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /operationSent: post: description: Evento disparado quando o envio das operações das cobranças para a eSales foi finalizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processId – accountsReceivable properties: processId: type: string description: Identificador do processo accountsReceivable: type: array items: #/definitions/accountReceivableOperation description: Lista de títulos enviados para processamento de operações responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /operationFinished: post: description: Evento disparado no final do processo de operações de cobrança Boleto x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processId – accountsReceivable properties: processId: type: string description: Identificador do processo accountsReceivable: type: array items: #/definitions/accountReceivableOperation description: Lista de títulos enviados para processamento de operações responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /bankSlipCreated: post: description: Evento público responsável pela retorno da criação do boleto para a cobrança x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – accountsReceivable properties: accountsReceivable: type: array items: #/definitions/recAccountsReceivableCreated description: Lista de cobranças responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /bankSlipReceived: post: description: Evento público responsável pela retorno do pagamento do boleto x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – accountsReceivable properties: accountsReceivable: type: array items: #/definitions/recAccountsReceivablePaydOff description: Lista de cobranças responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: enumSituationOperation: type: string enum: – WRITTEN_OFF – NOT_WRITTEN_OFF – CHANGED_DUE_DATE – NOT_CHANGED_DUE_DATE – PROTESTED – NOT_PROTESTED – CANCELED_PROTEST – NOT_CANCELED_PROTEST – PROCESS_WRITTEN_OFF – PROCESS_CHANGE_DUE_DATE – PROCESS_PROTEST – PROCESS_CANCEL_PROTEST – PROCESS_CHANGE_VALUE – CHANGED_VALUE – NOT_CHANGED_VALUE – PROCESS_CHANGE_INTEREST – CHANGED_INTEREST – NOT_CHANGED_INTEREST – PROCESS_CHANGE_ASSESSMENT – CHANGED_ASSESSMENT – NOT_CHANGED_ASSESSMENT – PROCESS_CHANGE_DISCOUNT – CHANGED_DISCOUNT – NOT_CHANGED_DISCOUNT – PROCESS_CANCEL_BANK_SLIP – CANCELED_BANK_SLIP – NOT_CANCELED_BANK_SLIP enumSituationCreated: type: string enum: – CREATED – NOT_CREATED accountReceivableOperation: type: object required: – id – situation properties: id: type: string description: Identificador do título situation: #/definitions/enumSituationOperation message: type: string description: Mensagem recAccountsReceivableCreated: type: object required: – accountReceivableId – situation properties: accountReceivableId: type: string description: Identificador do título situation: #/definitions/enumSituationCreated digitableLine: type: string description: Linha digitável ourNumber: type: string description: Nosso número occurrence: #/definitions/recOcurrence causesOccurrence: type: array items: #/definitions/recOcurrence description: Motivos da ocorrência errors: type: array items: #/definitions/recError description: Lista de erros na geração do boleto pixCopyAndPaste: type: string description: PIX Copia e Cola gerado pelo banco pixQRCode: type: string description: Pix QRCode recOcurrence: type: object required: – code – description properties: code: type: string description: Código description: type: string description: Descrição recError: type: object required: – message properties: message: type: string description: Mensagem de erro field: type: string description: Campo do erro recAccountsReceivablePaydOff: type: object required: – accountReceivableId – valueReceived – originalValue – rebateValue – assessmentValue – discountValue – interestValue – payDate properties: accountReceivableId: type: string description: Identificador do título valueReceived: type: string description: Valor recebido originalValue: type: string description: Valor original rebateValue: type: string description: Valor de abatimento assessmentValue: type: string description: Valor de multa discountValue: type: string description: Valor de desconto interestValue: type: string description: Valor de juros payDate: type: string description: Data do recebimento format: date occurrence: #/definitions/recOcurrence causesOccurrence: type: array items: #/definitions/recOcurrence description: Motivos da ocorrência genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE