Pular para o conteúdo principal
Consulta uma instrução de pagamento

Autorizações

Authorization
string
header
obrigatório

Copie 'Bearer ' + token

Parâmetros de caminho

codigoInstrucaoPagamento
string<uuid>
obrigatório

Código identificador (UUID) da instrução de pagamento.

Resposta

Success

codigo
string<uuid>

Código identificador da instrução de pagamento.

codigoAutorizacao
string<uuid>

Código identificador da autorização de recorrência vinculada.

codigoConta
string<uuid>

Código identificador da conta do pagador.

idRecorrencia
string | null

Identificador da recorrência no SPI (idRec).

contrato
object | null

Dados do contrato vinculado à recorrência.

dtLiquidacao
string<date-time>

Data prevista para liquidação do pagamento.

recebedor
object | null

Dados do recebedor.

devedor
object | null

Dados do devedor.

valor
number<double>

Valor da cobrança.

situacao
enum<integer>

Situação da instrução de pagamento.

Valores: 1 - Aceito 2 - Rejeitado 3 - AguardandoCancelamento 4 - Cancelado 5 - EmLiquidacao 6 - Liquidado

Opções disponíveis:
1,
2,
3,
4,
5,
6
motivoCancelamento
enum<integer> | null

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)

Opções disponíveis:
0,
1,
2,
3,
4
motivoRejeicao
enum<integer> | null

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

Opções disponíveis:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19
dtHoraCriacao
string<date-time> | null

Data e hora de criação da instrução.

dtHoraAlteracao
string<date-time> | null

Data e hora da última alteração da instrução.

idConciliacaoRecebedor
string | null

Identificador de conciliação do recebedor.

informacoesEntreUsuarios
string | null

Informações enviadas pelo recebedor ao pagador.

finalidadeAgendamento
enum<integer> | null

Finalidade do agendamento.

Valores: 1 - Agendamento 2 - AgendamentoNovaTentativa 3 - ReenvioDevidoErroLiquidacao

Opções disponíveis:
1,
2,
3
numeroOperacao
string | null

Número da operação do pagamento.