Scopes:
api.pix api.pixautomatico.instrucao.consultar ## OpenAPI ````yaml get /api/v1/pix-automatico/instrucoes-pagamentos openapi: 3.0.1 info: title: Api Externa BMP SPI description: 'Build Number: #0.0
' version: v1 servers: - url: https://api.ext.pix.dbs.moneyp.dev.br/ description: Localhost security: - Bearer: [] paths: /api/v1/pix-automatico/instrucoes-pagamentos: get: tags: - InstrucoesPagamentos summary: Lista as instruções de pagamento do parceiro description: "Scopes:
\r\napi.pix api.pixautomatico.instrucao.consultar" parameters: - name: Situacao in: query description: |- Filtra pela situação da instrução de pagamento. Valores: 1 - Aceito 2 - Rejeitado 3 - AguardandoCancelamento 4 - Cancelado 5 - EmLiquidacao 6 - Liquidado schema: allOf: - $ref: >- #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.SituacaoInstrucao description: |- Filtra pela situação da instrução de pagamento. Valores: 1 - Aceito 2 - Rejeitado 3 - AguardandoCancelamento 4 - Cancelado 5 - EmLiquidacao 6 - Liquidado - name: PageSize in: query description: Número de itens devolvidos por página. schema: type: integer format: int32 description: Número de itens devolvidos por página. - name: Page in: query description: Página que deve ser retornada. schema: type: integer format: int32 description: Página que deve ser retornada. responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.ListarInstrucaoPagamentoResponse '400': description: Erro de negócio content: application/json: schema: type: object properties: sucesso: type: boolean mensagem: type: string '500': description: Erro interno do servidor content: application/json: schema: type: object properties: sucesso: type: boolean mensagem: type: string components: schemas: BMPSPB.Infra.Enums.PixAutomatico.SituacaoInstrucao: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer description: '' format: int32 BMPSPB.Domain.Messaging.SPI.PixAutomatico.ListarInstrucaoPagamentoResponse: type: object properties: instrucoes: type: array items: $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.InstrucaoPagamentoResponse description: Lista de instruções de pagamento da página. nullable: true totalPages: type: integer description: Quantidade total de páginas. format: int32 totalRecords: type: integer description: Quantidade total de registros. format: int32 additionalProperties: false BMPSPB.Domain.Messaging.SPI.PixAutomatico.InstrucaoPagamentoResponse: type: object properties: codigo: type: string description: Código identificador da instrução de pagamento. format: uuid codigoAutorizacao: type: string description: Código identificador da autorização de recorrência vinculada. format: uuid codigoConta: type: string description: Código identificador da conta do pagador. format: uuid idRecorrencia: type: string description: Identificador da recorrência no SPI (idRec). nullable: true contrato: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.Contrato description: Dados do contrato vinculado à recorrência. nullable: true dtLiquidacao: type: string description: Data prevista para liquidação do pagamento. format: date-time recebedor: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.Pessoa description: Dados do recebedor. nullable: true devedor: allOf: - $ref: >- #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.Pessoa description: Dados do devedor. nullable: true valor: type: number description: Valor da cobrança. format: double situacao: allOf: - $ref: >- #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.SituacaoInstrucao description: |- Situação da instrução de pagamento. Valores: 1 - Aceito 2 - Rejeitado 3 - AguardandoCancelamento 4 - Cancelado 5 - EmLiquidacao 6 - Liquidado motivoCancelamento: allOf: - $ref: '#/components/schemas/BMPSPB.Infra.Enums.MotivoCancelamento' description: |- Motivo do cancelamento, quando cancelada. Valores: 0 - USER_REQUESTED (Solicitação do usuário) 1 - ACCOUNT_CLOSURE (Fechamento de conta) 2 - FRAUD (Fraude) 3 - DEFAULT_OPERATION (Operação padrão) 4 - RECONCILIATION (Reconciliação) nullable: true motivoRejeicao: allOf: - $ref: >- #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.MotivoRejeicaoInstrucaoPagamento description: |- Motivo da rejeição, quando rejeitada. Valores: 0 - AB10 - ErroParticipanteRecebedor 1 - AC05 - ContaEncerrada 2 - AC06 - ContaBloqueada 3 - AG12 - TransferenciaNaoPermitida 4 - AM02 - ValorNaoPermitido 5 - AM09 - ValorIncorreto 6 - DENC - CpfCnpjNaoCorrespondente 7 - DS27 - ParticipanteNaoAtivo 8 - DTED - DataVencimentoInvalida 9 - DTNT - TentativaAgendamentoForaLimite 10 - FBRD - RecebimentoForaDoPrazo 11 - IRNT - CobrancaRecorrenteNaoPermiteNovasTentativas 12 - MIDI - IdRecorrenciaInvalido 13 - MSUC - StatusRecorrenciaInvalido 14 - NIEC - NovoPagamentoNaoPermitido 15 - NIPA - PagamentoJaEfetuado 16 - NITX - InstrucaoNaoCorrespondeCobrancaAnterior 17 - QUNT - QuantidadeTentativasExcedida 18 - RC09 - IspbInvalido 19 - UDEI - CpfCnpjDevedorIncorreto nullable: true dtHoraCriacao: type: string description: Data e hora de criação da instrução. format: date-time nullable: true dtHoraAlteracao: type: string description: Data e hora da última alteração da instrução. format: date-time nullable: true idConciliacaoRecebedor: type: string description: Identificador de conciliação do recebedor. nullable: true informacoesEntreUsuarios: type: string description: Informações enviadas pelo recebedor ao pagador. nullable: true finalidadeAgendamento: allOf: - $ref: >- #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.FinalidadeAgendamento description: |- Finalidade do agendamento. Valores: 1 - Agendamento 2 - AgendamentoNovaTentativa 3 - ReenvioDevidoErroLiquidacao nullable: true numeroOperacao: type: string description: Número da operação do pagamento. nullable: true additionalProperties: false BMPSPB.Domain.Messaging.SPI.PixAutomatico.Contrato: type: object properties: descricao: type: string description: Descrição do contrato/objeto da recorrência. nullable: true numero: type: string description: Número do contrato. nullable: true additionalProperties: false BMPSPB.Domain.Messaging.SPI.PixAutomatico.Pessoa: type: object properties: nome: type: string description: Nome da pessoa. nullable: true documento: type: string description: CPF/CNPJ da pessoa. nullable: true additionalProperties: false BMPSPB.Infra.Enums.MotivoCancelamento: enum: - 0 - 1 - 2 - 3 - 4 type: integer description: '' format: int32 BMPSPB.Infra.Enums.PixAutomatico.MotivoRejeicaoInstrucaoPagamento: enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 type: integer description: '' format: int32 BMPSPB.Infra.Enums.PixAutomatico.FinalidadeAgendamento: enum: - 1 - 2 - 3 type: integer description: '' format: int32 securitySchemes: Bearer: type: apiKey description: Copie 'Bearer ' + token name: Authorization in: header ````