Mais pesquisados:Customização, Tutorial, Documentação

pagamento

1 views 0 30/09/2025 integrador

2.0info: 1.16.0 pagamento description: Serviço de pagamento do banking x-senior-domain: Domínio de pagamento do banking x-senior-domain-path: erpx_bnk_pag x-senior-service-path: pagamento 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_pagsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /pagamento/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 /pagamento/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 /pagamento/queries/exportPagamentoDadosPix: 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 /pagamento/queries/exportPagamentoItemPix: 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 /pagamento/queries/exportPagamentoItemPixHistorico: 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 /pagamento/queries/exportPagamentoItemPixErro: 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 /pagamento/queries/exportPagamentoDadosBoleto: 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 /pagamento/queries/exportPagamentoItemBoleto: 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 /pagamento/queries/exportPagamentoItemBoletoHistorico: 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 /pagamento/queries/exportPagamentoItemBoletoErro: 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 /pagamento/queries/exportPagamentoDadosDarf: 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 /pagamento/queries/exportPagamentoItemDarf: 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 /pagamento/queries/exportPagamentoItemDarfHistorico: 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 /pagamento/queries/exportPagamentoItemDarfErro: 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 /pagamento/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 /pagamento/actions/retornoPagamentoESales: post: description: API responsável pelo retorno do processamento assíncrono dos pagamentos do parceiro eSales tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagamentos properties: pagamentos: type: array items: type: object allOf: – #/definitions/recPagamentoESalesRetorno minimum: 1 description: Lista dos pagamentos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/actions/retornoPagamentoBtg: 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 – data properties: webhookId: type: string description: ID do webhook no BTG event: type: string description: Evento publicado pelo BTG data: type: object allOf: – #/definitions/recPagamentoBtgRetorno description: Dados do pagamento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/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 /pagamento/actions/importPagamentoDadosPix: 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 /pagamento/actions/importPagamentoItemPix: 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 /pagamento/actions/importPagamentoItemPixHistorico: 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 /pagamento/actions/importPagamentoItemPixErro: 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 /pagamento/actions/importPagamentoDadosBoleto: 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 /pagamento/actions/importPagamentoItemBoleto: 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 /pagamento/actions/importPagamentoItemBoletoHistorico: 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 /pagamento/actions/importPagamentoItemBoletoErro: 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 /pagamento/actions/importPagamentoDadosDarf: 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 /pagamento/actions/importPagamentoItemDarf: 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 /pagamento/actions/importPagamentoItemDarfHistorico: 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 /pagamento/actions/importPagamentoItemDarfErro: 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 /pagamento/events/importPagamentoDadosPixEvent: 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 /pagamento/events/exportPagamentoDadosPixEvent: 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 /pagamento/events/importPagamentoItemPixEvent: 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 /pagamento/events/exportPagamentoItemPixEvent: 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 /pagamento/events/importPagamentoItemPixHistoricoEvent: 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 /pagamento/events/exportPagamentoItemPixHistoricoEvent: 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 /pagamento/events/importPagamentoItemPixErroEvent: 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 /pagamento/events/exportPagamentoItemPixErroEvent: 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 /pagamento/events/importPagamentoDadosBoletoEvent: 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 /pagamento/events/exportPagamentoDadosBoletoEvent: 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 /pagamento/events/importPagamentoItemBoletoEvent: 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 /pagamento/events/exportPagamentoItemBoletoEvent: 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 /pagamento/events/importPagamentoItemBoletoHistoricoEvent: 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 /pagamento/events/exportPagamentoItemBoletoHistoricoEvent: 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 /pagamento/events/importPagamentoItemBoletoErroEvent: 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 /pagamento/events/exportPagamentoItemBoletoErroEvent: 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 /pagamento/events/importPagamentoDadosDarfEvent: 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 /pagamento/events/exportPagamentoDadosDarfEvent: 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 /pagamento/events/importPagamentoItemDarfEvent: 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 /pagamento/events/exportPagamentoItemDarfEvent: 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 /pagamento/events/importPagamentoItemDarfHistoricoEvent: 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 /pagamento/events/exportPagamentoItemDarfHistoricoEvent: 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 /pagamento/events/importPagamentoItemDarfErroEvent: 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 /pagamento/events/exportPagamentoItemDarfErroEvent: 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 /pagamento/entities/pagamentoItemPix: 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/pagamentoItemPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemPixHistorico: 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/pagamentoItemPixHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemPix/{parentId}/pagamentoItemPixHistoricos: 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/pagamentoItemPixHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemPixHistorico 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/pagamentoItemPixHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemPixHistorico 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/pagamentoItemPixHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemPix/{parentId}/pagamentoItemPixHistoricos/{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/editPagamentoItemPixHistorico responses: 200: description: Ok schema: #/definitions/editPagamentoItemPixHistorico 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/pagamentoItemPixHistorico responses: 200: description: Ok schema: #/definitions/pagamentoItemPixHistorico 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/pagamentoItemPixHistorico 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 /pagamento/entities/pagamentoItemPix/{parentId}/pagamentoItemPixErros: 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/pagamentoItemPixErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemPixErro 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/pagamentoItemPixErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemPixErro 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/pagamentoItemPixErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemPix/{parentId}/pagamentoItemPixErros/{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/editPagamentoItemPixErro responses: 200: description: Ok schema: #/definitions/editPagamentoItemPixErro 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/pagamentoItemPixErro responses: 200: description: Ok schema: #/definitions/pagamentoItemPixErro 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/pagamentoItemPixErro 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 /pagamento/entities/pagamentoItemBoleto: 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/pagamentoItemBoleto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemBoletoHistorico: 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/pagamentoItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemBoleto/{parentId}/pagamentoItemBoletoHistoricos: 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/pagamentoItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemBoletoHistorico 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/pagamentoItemBoletoHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemBoletoHistorico 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/pagamentoItemBoletoHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemBoleto/{parentId}/pagamentoItemBoletoHistoricos/{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/editPagamentoItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/editPagamentoItemBoletoHistorico 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/pagamentoItemBoletoHistorico responses: 200: description: Ok schema: #/definitions/pagamentoItemBoletoHistorico 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/pagamentoItemBoletoHistorico 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 /pagamento/entities/pagamentoItemBoleto/{parentId}/pagamentoItemBoletoErros: 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/pagamentoItemBoletoErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemBoletoErro 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/pagamentoItemBoletoErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemBoletoErro 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/pagamentoItemBoletoErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemBoleto/{parentId}/pagamentoItemBoletoErros/{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/editPagamentoItemBoletoErro responses: 200: description: Ok schema: #/definitions/editPagamentoItemBoletoErro 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/pagamentoItemBoletoErro responses: 200: description: Ok schema: #/definitions/pagamentoItemBoletoErro 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/pagamentoItemBoletoErro 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 /pagamento/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfHistoricos: 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/pagamentoItemDarfHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfHistorico 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/pagamentoItemDarfHistorico responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfHistorico 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/pagamentoItemDarfHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfHistoricos/{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/editPagamentoItemDarfHistorico responses: 200: description: Ok schema: #/definitions/editPagamentoItemDarfHistorico 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/pagamentoItemDarfHistorico responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfHistorico 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/pagamentoItemDarfHistorico 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 /pagamento/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfErros: 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/pagamentoItemDarfErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfErro 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/pagamentoItemDarfErro responses: 200: description: The created resources schema: type: array items: #/definitions/pagamentoItemDarfErro 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/pagamentoItemDarfErro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pagamento/entities/pagamentoItemDarf/{parentId}/pagamentoItemDarfErros/{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/editPagamentoItemDarfErro responses: 200: description: Ok schema: #/definitions/editPagamentoItemDarfErro 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/pagamentoItemDarfErro responses: 200: description: Ok schema: #/definitions/pagamentoItemDarfErro 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/pagamentoItemDarfErro 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 enumSituacaoPagamentoItemDetalhes: type: string enum: – PAGAMENTO_VALIDADO – PROCESSANDO_ENVIO_PAGAMENTO – PAGAMENTO_ENVIADO – PAGAMENTO_COM_PROBLEMAS – PAGAMENTO_AGENDADO – PAGAMENTO_NAO_AGENDADO – PAGAMENTO_EFETUADO – FALHA_NA_VALIDACAO description: Enumeration de situação dos detalhes do pagamento item: * `PAGAMENTO_VALIDADO` – Pagamento validado * `PROCESSANDO_ENVIO_PAGAMENTO` – Processando envio do pagamento * `PAGAMENTO_ENVIADO` – Pagamento enviado * `PAGAMENTO_COM_PROBLEMAS` – Pagamento com problemas * `PAGAMENTO_AGENDADO` – Pagamento agendado * `PAGAMENTO_NAO_AGENDADO` – Pagamento não agendado * `PAGAMENTO_EFETUADO` – Pagamento efetuado * `FALHA_NA_VALIDACAO` – Falha na validação enumSituacaoPagamentoItem: type: string enum: – AGUARDANDO_PAGAMENTO – PROCESSANDO_ENVIO_PAGAMENTO – PAGAMENTO_ENVIADO – PAGAMENTO_AGENDADO – PAGAMENTO_NAO_AGENDADO – PAGAMENTO_EFETUADO – PAGAMENTO_COM_PROBLEMAS – PAGAMENTO_INAPTO_PARA_PROCESSAMENTO – ERRO_INESPERADO – PAGAMENTO_INATIVADO – FALHA_NA_VALIDACAO description: Enumeration de situação do pagamento item: * `AGUARDANDO_PAGAMENTO` – Aguardando pagamento * `PROCESSANDO_ENVIO_PAGAMENTO` – Processando envio pagamento * `PAGAMENTO_ENVIADO` – Pagamento enviado * `PAGAMENTO_AGENDADO` – Pagamento agendado * `PAGAMENTO_NAO_AGENDADO` – Pagamento não agendado * `PAGAMENTO_EFETUADO` – Pagamento efetuado * `PAGAMENTO_COM_PROBLEMAS` – Pagamento com problemas * `PAGAMENTO_INAPTO_PARA_PROCESSAMENTO` – Pagamento inapto para processamento * `ERRO_INESPERADO` – Erro inesperado * `PAGAMENTO_INATIVADO` – Pagamento inativado * `FALHA_NA_VALIDACAO` – Falha na validação enumTipoPagamentoBtg: type: string enum: – PIX_KEY – BANKSLIP – UTILITIES – PIX_MANUAL – PIX_QR_CODE – PIX_REVERSAL – DARF description: Enumeration do tipo de pagamento do BTG: * `PIX_KEY` – Chave pix * `BANKSLIP` – Boleto * `UTILITIES` – Utilidades * `PIX_MANUAL` – Pix manual * `PIX_QR_CODE` – Pix copia e cola * `PIX_REVERSAL` – Pix estorno * `DARF` – Documento de Arrecadação de Receitas Federais (DARF) enumStatusPagamentoBtg: type: string enum: – CONFIRMED – FAILED – SCHEDULED – Authorization – Authorized – CANCELED – REVERTED description: Enumeration do status do pagamento do BTG: * `CONFIRMED` – Confirmado * `FAILED` – Rejeitado * `SCHEDULED` – Agendado * `Authorization` – Pendente de autorização * `Authorized` – Autorizado * `CANCELED` – Cancelado * `REVERTED` – Estornado enumStatusRegistroCobrancaRetornoESales: type: string enum: – ENVIADO_AO_BANCO – ERRO_DE_COMUNICACAO – INVALIDO – INCLUIDO – REJEITADO – LIQUIDADO description: Enumeration dos status do pagamento no retorno da eSales: * `ENVIADO_AO_BANCO` – Enviado ao banco * `ERRO_DE_COMUNICACAO` – Erro de comunicação * `INVALIDO` – Inválido * `INCLUIDO` – Incluído * `REJEITADO` – Rejeitado * `LIQUIDADO` – Liquidado enumModalidadeRetornoESales: type: string enum: – BOLETO – TRANSFERENCIA – GUIA_COM_CODIGO_BARRAS – PIX description: Enumeration com as modalidades do parceiro eSales: * `BOLETO` – Boleto * `TRANSFERENCIA` – Transferência * `GUIA_COM_CODIGO_BARRAS` – Guia com código de barras * `PIX` – Pix enumOrigemErro: type: string enum: – BANKING – PARCEIRO – BANCO description: Enumeration da origem do erro do título: * `BANKING` – Banking * `PARCEIRO` – Parceiro * `BANCO` – Banco enumFormaPagamento: type: string enum: – PIX_COPIA_COLA – CHAVE_PIX – TRANSFERENCIA_BANCARIA – PIX_DEVOLUCAO description: Enumeration das formas de pagamento: * `PIX_COPIA_COLA` – Pix copia e cola * `CHAVE_PIX` – Chave pix * `TRANSFERENCIA_BANCARIA` – Transferência bancária * `PIX_DEVOLUCAO` – Devolução de pix enumTipoChavePix: type: string enum: – TELEFONE – EMAIL – CHAVE_ALEATORIA – CPF – CNPJ description: Enumeration dos tipos de chave pix: * `TELEFONE` – Chave telefone * `EMAIL` – Chave email * `CHAVE_ALEATORIA` – Chave aleatória * `CPF` – Chave CPF * `CNPJ` – Chave CNPJ enumTipoConta: type: string enum: – CONTA_CORRENTE – CONTA_PAGAMENTO – CONTA_POUPANCA description: Enumeration dos tipos de contas bancárias: * `CONTA_CORRENTE` – Conta corrente * `CONTA_PAGAMENTO` – Conta pagamento * `CONTA_POUPANCA` – Conta poupança 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 recPagamentoESalesRetorno: description: Record com as informações de retorno do pagamento do parceiro eSales type: object required: – seuNumero – status properties: seuNumero: type: string description: Seu número status: type: string allOf: – #/definitions/enumStatusRegistroCobrancaRetornoESales description: Status do pagamento valorPago: type: string description: Valor pago dataLiquidacao: type: string format: date description: Data de liquidação autenticacaoBancaria: type: string description: Autenticação bancária ocorrencias: type: array items: type: object allOf: – #/definitions/recOcorrenciaRetornoESales description: Lista de ocorrências modalidade: type: string allOf: – #/definitions/enumModalidadeRetornoESales description: Modalidade problema: type: object allOf: – #/definitions/recProblemaPagamentoRetornoESales description: Problema recOcorrenciaRetornoESales: description: Record com a informação da ocorrência type: object properties: codigo: type: string description: Código descricao: type: string description: Descrição recProblemaPagamentoRetornoESales: description: Record do problema do pagamento retornado 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/recViolacoesPagamentoRetornoESales description: Violações recViolacoesPagamentoRetornoESales: description: Record de violações do pagamento retornado pelo parceiro type: object properties: razao: type: string description: Razão propriedade: type: string description: Propriedade valor: type: string description: Valor recPagamentoBtgRetorno: description: Record do pagamento que foi retornado pelo parceiro BTG type: object properties: paymentId: type: string description: Id do pagamento type: type: string allOf: – #/definitions/enumTipoPagamentoBtg description: Tipo de pagamento amount: type: string description: Valor do pagamento scheduledDate: type: string format: date description: Data de agendamento paymentDate: type: string format: date description: Data de pagamento status: type: string allOf: – #/definitions/enumStatusPagamentoBtg description: Status do pagamento debitParty: type: object allOf: – #/definitions/recParteDebitada description: Parte debitada detail: type: object allOf: – #/definitions/recDetalhesPagamento description: Detalhes do pagamento tags: type: object allOf: – #/definitions/recTags description: Tags errors: type: array items: type: object allOf: – #/definitions/recErroBtg description: Erros no pagamento authenticationCode: type: string description: Autenticação do pagamento approvalId: type: string description: Id da aprovação taxId: type: string description: CPNJ createdAt: type: string format: date-time description: Criado em updatedAt: type: string format: date-time description: Atualizado em category: type: string allOf: – #/definitions/enumTipoPagamentoBtg description: Categoria de pagamento recParteDebitada: description: Record dos dados da parte debitada no BTG type: object properties: taxId: type: string description: CNPJ name: type: string description: Nome number: type: string description: Número da conta branchCode: type: string description: Agência bankCode: type: string description: Banco recBeneficiario: description: Record dos dados do beneficiario no BTG type: object properties: taxId: type: string description: CNPJ bankCode: type: string description: Banco socialName: type: string description: Nome social fantasyName: type: string description: Nome fantasia recDetalhesPagamento: description: Record dos dados da parte debitada no BTG type: object properties: creditParty: type: object allOf: – #/definitions/recParteCreditada description: Parte creditada key: type: object allOf: – #/definitions/recChavePix description: Chave pix endToEndId: type: string description: Identificador de transação payee: type: object allOf: – #/definitions/recBeneficiario description: Beneficiário barcode: type: string description: Código de barras dueDate: type: string format: date description: Data de vencimento digitableLine: type: string description: Linha digitável recChavePix: description: Record dos dados do pix do pagamento no BTG type: object properties: type: type: string description: Tipo value: type: string description: Valor recParteCreditada: description: Record dos dados da parte creditada no BTG type: object properties: name: type: string description: Nome taxId: type: string description: CNPJ account: type: object allOf: – #/definitions/recConta description: Número da conta recConta: description: Record dos dados da conta no BTG type: object properties: ispb: type: string description: ISPB type: type: string description: Tipo branchCode: type: string description: Agência number: type: string description: Número bankCode: type: string description: Banco recTags: description: Record dos dados externos enviados pelo Banking ao BTG type: object properties: externalId: type: string description: Id externo recErroBtg: description: Record dos dados de erro no pagamento do BTG type: object properties: detail: type: string description: Mensagem de erro code: type: string description: Código do erro pagamentoDadosPix: description: Entidade de dados do pagamento de pix type: object required: – loteId – agencia – conta properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Identificador do lote codigoLote: type: string description: Código do lote agencia: type: string maxLength: 5 description: Número da agência digitoAgencia: type: string maxLength: 2 description: Dígito da agência conta: type: string maxLength: 15 description: Número da conta digitoConta: type: string maxLength: 2 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: pagamentoItemPix: description: Entidade de dados do título do pagamento de pix type: object required: – seuNumero – numeroTitulo – formaPagamento – valorOriginal – dataPagamento – situacao – documentoFavorecido – nomeFavorecido properties: id: type: string format: uuid description: Identificador do registro seuNumero: type: string maxLength: 20 description: Seu número numeroTitulo: type: string description: Número do título formaPagamento: type: string allOf: – #/definitions/enumFormaPagamento description: Forma de pagamento valorOriginal: type: string description: Valor original do título dataPagamento: type: string format: date description: Data do pagamento situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItem description: Situação do título documentoFavorecido: type: string maxLength: 14 description: Documento do favorecido nomeFavorecido: type: string description: Nome do favorecido tipoChavePixFavorecido: type: string allOf: – #/definitions/enumTipoChavePix description: Tipo de chave pix do favorecido chavePixFavorecido: type: string description: Chave pix do favorecido pixCopiaColaFavorecido: type: string description: Pix copia e cola do favorecido codigoBancoFavorecido: type: string maxLength: 3 description: Codigo do banco do favorecido agenciaFavorecido: type: string maxLength: 5 description: Número da agência do favorecido digitoAgenciaFavorecido: type: string maxLength: 2 description: Dígito da agência do favorecido contaFavorecido: type: string maxLength: 15 description: Número da conta do favorecido digitoContaFavorecido: type: string maxLength: 2 description: Dígito da conta do favorecido endToEndIdFavorecido: type: string description: Identificador único do pagamento tipoContaFavorecido: type: string allOf: – #/definitions/enumTipoConta description: Tipo de conta do favorecido pagamentoDadosPix: type: object allOf: – #/definitions/pagamentoDadosPix description: Registro de pagamento de dados pix pagamentoItemPixErros: type: array items: type: object allOf: – #/definitions/pagamentoItemPixErro description: Registros de erros do pagamento pagamentoItemPixHistoricos: type: array items: type: object allOf: – #/definitions/pagamentoItemPixHistorico description: Registros de históricos 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: pagamentoItemPixHistorico: description: Entidade de histórico do título de pagamento pix type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro pagamentoItemPix: type: object allOf: – #/definitions/pagamentoItemPix description: Registro de pagamento do item pix situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItemDetalhes 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: editPagamentoItemPixHistorico: type: object required: – id allOf: – #/definitions/pagamentoItemPixHistorico pagamentoItemPixErro: description: Entidade de dados do título da pagamento pix com erro type: object required: – motivo – origem properties: id: type: string format: uuid description: Identificador do registro pagamentoItemPix: type: object allOf: – #/definitions/pagamentoItemPix description: Registro de pagamento do item pix campo: type: string description: Campo do erro motivo: type: string description: Motivo origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemPixErro: type: object required: – id allOf: – #/definitions/pagamentoItemPixErro pagamentoDadosBoleto: description: Entidade de dados do pagamento de boleto type: object required: – loteId – numeroAgencia – numeroConta properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Identificador do lote codigoLote: type: string description: Código do lote numeroAgencia: type: string maxLength: 5 description: Número da agência digitoAgencia: type: string maxLength: 2 description: Dígito da agência numeroConta: type: string maxLength: 12 description: Número da conta digitoConta: type: string maxLength: 2 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: pagamentoItemBoleto: description: Entidade de dados do título do pagamento de boleto type: object required: – seuNumero – numeroTitulo – codigoBarras – valorOriginal – dataPagamento – situacao properties: id: type: string format: uuid description: Identificador do registro seuNumero: type: string maxLength: 20 description: Seu número numeroTitulo: type: string description: Número do título codigoBarras: type: string maxLength: 48 description: Código de barras valorOriginal: type: string description: Valor original do título dataPagamento: type: string format: date description: Data do pagamento situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItem description: Situação do título pagamentoDadosBoleto: type: object allOf: – #/definitions/pagamentoDadosBoleto description: Registro de pagamento de dados boleto pagamentoItemBoletoErros: type: array items: type: object allOf: – #/definitions/pagamentoItemBoletoErro description: Registros de erros do pagamento pagamentoItemBoletoHistoricos: type: array items: type: object allOf: – #/definitions/pagamentoItemBoletoHistorico description: Registros de históricos 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: pagamentoItemBoletoHistorico: description: Entidade de histórico do título de pagamento boleto type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro pagamentoItemBoleto: type: object allOf: – #/definitions/pagamentoItemBoleto description: Registro de pagamento do item boleto situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItemDetalhes 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: editPagamentoItemBoletoHistorico: type: object required: – id allOf: – #/definitions/pagamentoItemBoletoHistorico pagamentoItemBoletoErro: description: Entidade de dados do título da pagamento boleto com erro type: object required: – motivo – origem properties: id: type: string format: uuid description: Identificador do registro pagamentoItemBoleto: type: object allOf: – #/definitions/pagamentoItemBoleto description: Registro de pagamento do item boleto campo: type: string description: Campo do erro motivo: type: string description: Motivo origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemBoletoErro: type: object required: – id allOf: – #/definitions/pagamentoItemBoletoErro pagamentoDadosDarf: description: Entidade de dados do pagamento de DARF type: object required: – loteId properties: id: type: string format: uuid description: Identificador do registro loteId: type: string format: uuid description: Identificador do lote usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: pagamentoItemDarf: description: Entidade de dados do título do pagamento de DARF type: object required: – seuNumero – situacao properties: id: type: string format: uuid description: Identificador do registro pagamentoDadosDarf: type: object allOf: – #/definitions/pagamentoDadosDarf description: Registro de pagamento de dados darf seuNumero: type: string maxLength: 20 description: Seu número situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItem description: Situação do título pagamentoItemDarfHistoricos: type: array items: type: object allOf: – #/definitions/pagamentoItemDarfHistorico description: Registros de históricos do título pagamentoItemDarfErros: type: array items: type: object allOf: – #/definitions/pagamentoItemDarfErro description: Registros de erros do pagamento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: pagamentoItemDarfHistorico: description: Entidade de histórico do título de pagamento DARF type: object required: – id – situacao properties: id: type: string format: uuid description: Identificador do registro pagamentoItemDarf: type: object allOf: – #/definitions/pagamentoItemDarf description: Registro de pagamento do item DARF situacao: type: string allOf: – #/definitions/enumSituacaoPagamentoItemDetalhes 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: editPagamentoItemDarfHistorico: type: object required: – id allOf: – #/definitions/pagamentoItemDarfHistorico pagamentoItemDarfErro: description: Entidade de dados do título da pagamento DARF com erro type: object required: – motivo – origem properties: id: type: string format: uuid description: Identificador do registro pagamentoItemDarf: type: object allOf: – #/definitions/pagamentoItemDarf description: Registro de pagamento do item DARF campo: type: string description: Campo do erro motivo: type: string description: Motivo origem: type: string allOf: – #/definitions/enumOrigemErro description: Origem usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editPagamentoItemDarfErro: type: object required: – id allOf: – #/definitions/pagamentoItemDarfErro 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação