2.0info: 2.3.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: /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: enumSituation: type: string enum: – CREATED – NOT_CREATED enumSituationCanceled: type: string enum: – CANCELED – NOT_CANCELED 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 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