Consulta de comprovante Pix

Permite consultar os dados de pagamentos de CIOT via PIX a fim de comprovar a quitação da parcela sem a necessidade de acessar o portal do NDD Cargo.

O parceiro só poderá consultar o comprovante das contratantes vinculadas ao seu Cliente ID.

observação

O escopo da API limita-se a consulta dos dados de transações PIX. Cabe a aplicação terceira gerar o comprovante em PDF a partir da consulta dos dados.

Método e rota

• Consulta (GET): /consulta/comprovantePix/:enterpriseId

Estrutura da requisição

Cabeçalhos

• Authorization: o token JWT deve ser enviado no header.

  Authorization: Bearer {token}

Corpo

Confira o exemplo abaixo e veja aqui a definição completa.

{
"CIOT": "880005224760/3822",
"Parcela":   "01"
}

Resposta do GET

Após o processamento da consulta, a API retornará um JSON com os seguintes dados:

Exemplo de resposta bem-sucedida:

{
"previousPage": 1,
"currentPage": 1,
"nextPage": 1,
 "last": false,
"totalPages": 1,
"totalItems": 1,
 "maxItemsPerPage": 50,
 "totalItemsPage": 1,
 "items": [
{
 "idAccount": 332622,
 "idEndToEnd": "E08744817202044060244RSSNZHUHXYY",
 "transactionDate": "2019-08-24T14:15:22Z",
"transactionType": "TRANSFER_DEBIT",
"transactionStatus": "EXECUTED",
 "transferType": 3,
"amount": 6,
"tariffAmount": 0.2,
 "finalAmount": 4.8,
 "idAdjustment": 589834,
 "transactionCode": "dff110ee-caea-4e66-8655-45c02371bfca",
 "tariffTransactionCode": "1d693889-fa54-4a4d-b1eb-61096256a60b",
 "idTx": "Codigorecebimento19831",
 "pixType": "TRANSFER",
"name": "Dock",
"purchaseAmount": 0,
 "changeAmount": 0,
 "agentWithdrawalIspb": "string",
 "agentMode": "string"
}
]
}

Layout

Parâmetro	Tipo	Descrição
transactionUUID	uuid	Identificador universal único na infraestrutura de cobrança do PIX.
idAccount	integer	Código de identificação da conta que possui a chave DICT (máx. 14 caracteres).
limit	integer	Número máximo de itens retornados por página.
page	integer	Número da página retornada.
date	date	Retorna os registros de uma data específica de transferência (formato ISO 8601).
from	date-time	Início do período para pesquisa dos registros de transferência (formato ISO 8601).
to	date-time	Fim do período para pesquisa dos registros de transferência (formato ISO 8601).
sort	string	Tipo de classificação dos registros pela data de transferência. Valores permitidos: asc ou desc.
idTx	string	Identificador utilizado para reconciliação do receptor.
transactionCode	uuid	Código da transação de pagamento (gerado mesmo que o pagamento não tenha ocorrido).
transferType	integer	Tipo de mecanismo utilizado para iniciar a transferência: 0 = Manual; 1 = Chave; 2 = QR Code estático; 3 = QR Code dinâmico; 4 = Iniciador de pagamento; 6 = Automático.
transactionType	string	Tipo de operação realizada. Valores permitidos: Transfer_debit ou Transfer_credit.
idEndToEnd	string	Identificação ponta a ponta do pagamento associado à solicitação. Corresponde ao campo E