erpx_bnk_cob (Domínio de cobrança do banking)

2.0info: 2.1.0 pix description: Serviço de cobranças via PIX x-senior-domain: Domínio de cobrança do banking x-senior-domain-path: erpx_bnk_cob x-senior-service-path: pix contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx_bnk_cob/pixsecurityDefinitions: 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: /registerPixBilling: post: description: API responsável pela criação do registro de cobrança assíncrona de PIX copia e cola ### Resources - res://senior.com.br/erpx_bnk_cob/pix/actions/registerPixBilling x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processId – receivableBank – company – branch – receivableBankData – accountsReceivable properties: processId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cobrança) receivableBank: #/definitions/enumReceivableBank company: #/definitions/recCompany branch: #/definitions/recBranch receivableBankData: #/definitions/recReceivableBankData accountsReceivable: type: array items: #/definitions/recAccountReceivable description: Lista de títulos que serão registrados as cobranças responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador do processo informado no input da API 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /cancelPixBilling: post: description: API responsável pelo cancelamento do registro de cobrança do PIX ### Resources - res://senior.com.br/erpx_bnk_cob/pix/actions/cancelPixBilling x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processId – accountsReceivableId properties: processId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cancelamento) accountsReceivableId: type: array items: type: string description: Lista de identificadores dos títulos a serem cancelados responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador do processo informado no input da API 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /pixCreated: post: description: API responsável pela retorno da criação do pix 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: – processId – accountsReceivable properties: processId: type: string description: Identificador do processo (valor será retornado no final do processo, para facilitar identificação do registro de cobrança) accountsReceivable: type: array items: #/definitions/accountsReceivableReturn description: Lista de títulos que serão registrados as cobranças responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /pixReceived: post: description: Evento responsável por avisar quando um pix gerado foi pago pelo fornecedor x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – accountsPaidOff properties: accountsPaidOff: type: array items: #/definitions/recAccountPaidOff description: Lista de títulos que foram pagos responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /pixCanceled: post: description: Evento disparado no final do processo de cancelamento de cobrança PIX 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 (valor será retornado no final do processo, para facilitar identificação do registro de cancelamento) accountsReceivable: type: array items: #/definitions/accountReceivableCanceled description: Lista de títulos enviados para cancelamento responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: enumReceivableBank: type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO enumCalculationTypeInterest: type: string enum: – VALUE_FOR_CALENDAR_DAYS – PERCENTAGE_FOR_CALENDAR_DAYS – PERCENTAGE_FOR_CALENDAR_MONTH – PERCENTAGE_FOR_CALENDAR_YEAR – VALUE_FOR_BUSINESS_DAYS – PERCENTAGE_FOR_BUSINESS_DAYS – PERCENTAGE_FOR_BUSINESS_MONTH – PERCENTAGE_FOR_BUSINESS_YEAR enumCalculationType: type: string enum: – PERCENTAGE – FIXED_VALUE enumCalculationTypeDiscount: type: string enum: – FIXED_VALUE_UNTIL_LIMIT_DATE – PERCENTAGE_UNTIL_LIMIT_DATE – VALUE_FOR_ADVANCE_CALENDAR_DAY – VALUE_FOR_ADVANCE_BUSINESS_DAY – PERCENTAGE_FOR_ADVANCE_CALENDAR_DAY – PERCENTAGE_FOR_ADVANCE_BUSINESS_DAY enumSituation: type: string enum: – CREATED – NOT_CREATED enumSituationCanceled: type: string enum: – CANCELED – NOT_CANCELED recBranch: type: object properties: id: type: string description: Identificador do registro na plataforma code: type: integer description: Código documentNumber: type: string description: Número do documento nifNumber: type: string description: Número de identificação fiscal recAccountReceivable: type: object required: – accountReceivableId – accountReceivableNumber – accountReceivableType – customer – dueDate – values properties: accountReceivableId: type: string description: Identificador do título accountReceivableNumber: type: string description: Número do título accountReceivableType: type: string description: Tipo do título customer: #/definitions/recCustomer dueDate: type: string description: Data de vencimento format: date validityAfterExpiration: type: integer description: Dias corridos após o vencimento que a cobrança poderá ser paga values: #/definitions/recValuesRegisterBilling additionalPixInformations: #/definitions/recAdditionalPixInformations recCustomer: type: object properties: id: type: string description: Identificador do registro na plataforma documentNumber: type: string description: Número do documento name: type: string description: Nome tradeName: type: string description: Nome fantasia recValuesRegisterBilling: type: object required: – original properties: original: type: string description: Valor original interest: #/definitions/recCalculationInterest assessment: #/definitions/recCalculationValue rebate: #/definitions/recCalculationValue discount: #/definitions/recCalculationDiscount recCalculationInterest: type: object required: – calculationType – valueOrPercentage properties: calculationType: #/definitions/enumCalculationTypeInterest valueOrPercentage: type: string description: Valor ou porcentual recCalculationValue: type: object required: – calculationType – valueOrPercentage properties: calculationType: #/definitions/enumCalculationType valueOrPercentage: type: string description: Valor ou porcentual recCalculationDiscount: type: object required: – calculationType properties: calculationType: #/definitions/enumCalculationTypeDiscount valueOrPercentage: type: string description: Valor ou porcentual discountFixedDate: type: array items: #/definitions/recDiscountFixedDate description: Descontos definidos de acordo com a data estabelecida recDiscountFixedDate: type: object required: – limitDate – valueOrPercentage properties: limitDate: type: string description: Data limite format: date valueOrPercentage: type: string description: Valor ou percentual recAdditionalPixInformations: type: object properties: payerRequest: type: string description: Solicitação do pagador additionalInformations: type: array items: #/definitions/recAdditionalInformations description: Informações adicionais recAdditionalInformations: type: object required: – name – value properties: name: type: string description: Nome value: type: string description: Valor recReceivableBankData: type: object required: – pixKey – branchNumber – branchDigit – accountNumber – accountDigit properties: pixKey: type: string description: Chave pix branchNumber: type: integer description: Número da agência branchDigit: type: string description: Dígito da agência accountNumber: type: integer description: Número da conta accountDigit: type: string description: Dígito da conta accountsReceivableReturn: type: object required: – id – situation properties: id: type: string description: Identificador do título situation: #/definitions/enumSituation creationDate: type: string description: Data de criação do PIX format: date errors: type: array items: #/definitions/recError description: Lista de erros na geração do PIX pixCopyAndPaste: type: string description: PIX Copia e Cola gerado pelo banco pixQRCode: type: string description: Pix QRCode recError: type: object required: – message properties: message: type: string description: Mensagem de erro field: type: string description: Campo do erro recCompany: type: object properties: id: type: string description: Identificador do registro na plataforma code: type: integer description: Código recAccountPaidOff: type: object required: – accountReceivableId – valueReceived – originalValue – rebateValue – assessmentValue – discountValue – interestValue – payDate – endToEndId 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/Hora do Recebimento format: date-time payerInformation: type: string description: Informação do pagador endToEndId: type: string description: Identificador único do pagamento accountReceivableCanceled: type: object required: – id – situation properties: id: type: string description: Identificador do título situation: #/definitions/enumSituationCanceled erro: type: string description: Mensagem de erro 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