Depois de criar um pagamento, consulte o estado, atualize-o junto do prestador ou encontre pagamentos com filtros. As operações estão limitadas ao comerciante autenticado.
Listar Pagamentos
Lista os pagamentos do comerciante autenticado, do mais recente para o mais antigo. Combine os parâmetros abaixo para aplicar todos os filtros antes de paginar.
Pesquisar uma referência
Passe refPagamento do webhook PPR como search. A pesquisa é parcial e preserva os zeros à esquerda. Compare a reference devolvida com a referência completa quando precisar de uma correspondência exacta.
bash
Estado e intervalo de datas
bash
As datas filtram a criação do pagamento, com limites inclusivos. Use status=Failed para pagamentos marcados como falhados. As rejeições bancárias podem ser consultadas em GET /api/references/ppr/{reference}/attempts?status=Failed, quando o registo de tentativas está activo.
Paginação e PPR Charging
A resposta inclui data, pageNumber, pageSize, totalItems e totalPages. Os totais reflectem os filtros. Mantenha os mesmos filtros ao avançar as páginas. Uma pesquisa sem resultados devolve data: [].
As referências Charging permanecem reutilizáveis após uma cobrança. Esta lista exclui o registo principal e devolve os pagamentos individuais. Consulte o status de cada item e use o seu internalId em GET /api/payments/{paymentId}. Os exemplos usam dados fictícios.
query Parameters
pageNumberPage number.
pageSizeRegistos por página.
statusEstado do pagamento. Omita para incluir todos os estados.
paymentTypeTipo de pagamento.
startDateLimite inferior inclusivo da data de criação do pagamento. Envie um instante ISO 8601 em UTC.
endDateLimite superior inclusivo da data de criação do pagamento. Envie um instante ISO 8601 em UTC.
searchPesquisa parcial no valor da referência. Envie a referência completa e compare o valor devolvido para confirmar uma correspondência exacta.
Listar Pagamentos › Responses
Pagamentos paginados.
Obter Detalhes do Pagamento
Método e rota: GET /api/payments/{paymentId}. Consulta os detalhes atuais de um pagamento.
Use o id ou o internalId do pagamento. Para PPR Charging, use o internalId do pagamento individual na lista de pagamentos. Um número de referência pode devolver um único registo se coincidir com o ID guardado pelo conector. O UUID devolvido como id na resposta compacta de criação PPR identifica o registo da referência.
path Parameters
paymentIdExternal payment identifier.
Obter Detalhes do Pagamento › Responses
Detalhes do pagamento.
idinternalIdmerchantIdreferenceamountcurrencypaymentTypestatuscreatedAtcompletedAtdescriptioncustomerEmailcustomerNamecustomerTelephonedocumentNumberObjeto JSON definido pelo comerciante para associar um pagamento IZI Pay aos registos dos seus próprios sistemas.
Os nomes das propriedades são escolhidos pelo comerciante; as chaves do exemplo são ilustrativas e não constituem uma lista fixa. Cada propriedade pode conter uma string, número, booleano, array, objeto aninhado ou null. A escrita e a capitalização das chaves são preservadas.
A IZI Pay guarda estes valores sem os utilizar para controlar o processamento do pagamento. São devolvidos como customMetadata nas respostas de criação, detalhe e listagem de pagamentos e referências PPR.
Utilize este objeto para identificadores internos, como números de fatura, ordens de compra, departamentos, códigos de cliente ou referências do sistema de origem. Não inclua palavras-passe, tokens de acesso, dados de cartão ou outros segredos.
Sincronizar Estado do Pagamento
Coloca em fila uma atualização do estado do pagamento deste comerciante junto do prestador. Use o internalId (ou ID de pagamento do prestador) no caminho. HTTP 202 Accepted significa que a atualização foi agendada; não contém um novo estado. Consulte depois GET /api/payments/{paymentId} para ler o último resultado guardado.
path Parameters
paymentIdExternal payment identifier.
Sincronizar Estado do Pagamento › Responses
Atualização agendada. Corpo da resposta vazio.