Consulta de ordem de pagamento

Corpo do Response


CampoTipoDescrição
identifierStringIdentificador da ordem de pagamento
accountIdentifierStringidentificador da conta associada a ordem
qrCodeReferenceStringReferente ao qrCode da ordem
statusEnumStatus da ordem de pagamento
returnedValueNumberValor Retornado pela ordem
typeStringtipo de ordem
recipientObjectRecebedor da ordem de pagamento
└── ispbStringispb do recebedor
└── institutionStringInstituição financeira do recebedor
└── nameStringNome do recebedor
└── documentNumberStringNumero do documento do recebedor
└── branchStringFilial da instituição financeira do recebedor
└── numberStringNumero da conta do recebedor
└── typeEnumTipo de conta do recebedor
└── keyStringChave do recebedor
descriptionStringDescrição da ordem de pagamento
valueNumberValor da ordem de pagamento
transactionDateLocalDateData da transação da ordem de pagamento
effectiveTransactionTimeLocalDateData efetiva da transação da ordem de pagamento
originEnumOrigem da ordem
senderObjectRemetente da ordem de pagamento
└── ispbStringIspb do remetente
└── institutionStringInstituição financeira do remetente
└── nameStringNome do remetente
└── documentNumberStringNumero do documento do remetente
└── branchStringNumero da filial da instituição financeira do remetente
└── numberStringNumero da conta do remetente
└── typeEnumTipo de conta do remetente
└── keyStringChave do remetente
isInternalbooleanSinalização de ordem interna ou externa
scheduledTransferLocalDateAgendamento da transferência
endToEndStringEndToEnd da ordem de pagamento
movementIdNumberIdentificador da movimentação
sentErrorEnumPossível erro de envio
taxValueNumberValor da taxa associada a ordem
transactionIdentifierStringIdentificador da transação

Status possíveis

CampoDescrição
PAIDPago
SCHEDULEDAgendado
PENDINGPendente
CANCELEDCancelado
REQUESTEDRegistrado
RETURNEDRetornado
REJECTEDRejeitado
ERRORErro

Possíveis tipos de conta

CampoDescrição
CHECKINGVerificação
SALARYSalário
SAVINGSPoupança
TRANSACTIONALTransacional

Possíveis origins

CampoDescrição
BANK_ADDRESSEndereço bancário
QR_CODEQr code
KEYChave
REFUNDReembolso
INIC_PAGPagamento inicial
INIC_PAG_QR_CODEPagamento inicial de QR code
INIC_PAG_MANUPagamento inicial manual
INIC_PAG_CHAVEPagamento inicial com chave
DEVOLUCAO_ESPECIALDevolução especial

Possíveis erros

CampoDescrição
SPI_TIMEOUTTimeout do sistema
BLOCKED_RECIPIENT_ACCOUNTConta do recebedor bloqueada
FAILED_VALIDATION_RECIPIENT_ACCOUNTFalha ao validar a conta do recebedor
RECIPIENT_ACCOUNT_OVER_LIMITConta do recebedor fora do limite
PROCESSING_ERRORErro de processamento
RECIPIENT_PSP_TIMEOUTTimeout de recebedor do PSP
PSP_REJECTED_ORDEROrdem rejeitada pelo PSP
RECIPIENT_ACCOUNT_NONEXISTENTConta do recebedor não existente
RECIPIENT_ACCOUNT_CLOSEDConta do recebedor fechada
RECIPIENT_ACCOUNT_DIFFERENT_OWNERSHIPConta do recebedor possui uma propriedade diferente
RECIPIENT_ACCOUNT_OPERATION_UNSUPPORTEDOperação de conta do recebedor não suportada
PSP_NOT_IN_SPIPsp não consta no sistema
RECIPIENT_ACCOUNT_INVALID_TYPETipo de conta de recebedor inválida
SENDER_PSP_TIMEOUTTimeout de envio para PSP
INCORRECT_MESSAGEMensagem incorreta
RECIPIENT_ACCOUNT_INVALIDConta do recebedor inválida
UNKNOWN_ERRORErro desconhecido
ANTI_FRAUD_COMMUNICATION_ERRORComunicação anti fraude
VALIDATION_ERRORErro de validação
FRAUDFraude
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!