Schemas

MFA method identifier.

Montante do pagamento expresso na moeda selecionada. São suportados valores decimais.

Para GPO e PPR com metadata.referenceType: Dynamic, o montante deve estar entre 0.01 e 10.000.000. Numa referência PPR do tipo Charging, utilize 0 para um montante aberto, introduzido pelo cliente no momento do pagamento; também é aceite um montante positivo. Valores negativos nunca são permitidos.

Código de moeda de três letras maiúsculas, no formato ISO. Utilize AOA para pagamentos em kwanzas.

Meio de pagamento a utilizar. GPO cria um pagamento mobile money, uma autorização ou um QR Code; PPR cria uma referência de pagamento.

Identificador de pagamento definido pelo comerciante. É obrigatório para GPO e pode ter até 15 caracteres (cada método GPO pode impor um formato mais restrito).

Para PPR, omita o campo ou envie uma string vazia para que a IZI Pay gere uma referência de 9 dígitos. Para definir a referência, envie apenas dígitos e utilize entre 9 e 15 dígitos. Uma referência dinâmica definida pelo comerciante não pode ser reutilizada enquanto a mesma referência estiver ativa e não paga para a entidade.

Configurações específicas do tipo de pagamento para POST /api/payments.

As configurações do conector, como paymentMethod, referenceType, expiryDate e os campos do cliente, pertencem diretamente a este objeto. Os campos definidos pelo comerciante devem ser agrupados em metadata.custom; não coloque chaves arbitrárias do comerciante ao lado das configurações do conector.

Os valores enviados em metadata.custom são guardados com o pagamento e devolvidos na propriedade de topo customMetadata nas respostas de criação e consulta. Não envie um campo customMetadata no topo do pedido para /api/payments.

Fluxo GPO a iniciar. Utilize webframe para checkout alojado, onetimepurchase para um pagamento mobile imediato, authorization para reservar fundos, capture para concluir uma autorização anterior ou qrcode para criar um QR Code. Assume webframe quando omitido ou não reconhecido.

Número de telemóvel do cliente utilizado nos fluxos de pagamento mobile e autorização.

Operadora móvel ou provedor de pagamento utilizado na transação.

Identificador GPO do comerciante atribuído no onboarding. Também pode ser obtido da configuração do comerciante autenticado.

Identificador GPO do ponto de venda atribuído no onboarding. Também pode ser obtido da configuração do comerciante autenticado.

Tamanho solicitado para a imagem do QR Code. Utilizado apenas quando paymentMethod é qrcode; assume MEDIUM quando omitido.

Comportamento do QR Code. Utilizado apenas quando paymentMethod é qrcode; assume STATIC quando omitido.

Número máximo de pagamentos aceites pelo QR Code. Utilizado apenas em pagamentos por QR Code e assume 1 quando omitido.

Expiração opcional do QR Code em formato ISO 8601. Assume 24 horas após a criação quando omitida.

Identificador devolvido por uma autorização anterior. Obrigatório quando paymentMethod é capture.

Descrição enviada ao GPO. Em pagamentos por QR Code, é utilizada a reference de topo quando este valor é omitido.

Objeto JSON opcional definido pelo comerciante para dados internos de reconciliação.

O comerciante escolhe os nomes das propriedades. Os valores podem ser strings, números, booleanos, arrays, objetos aninhados ou null. A IZI Pay não utiliza estas propriedades para selecionar ou configurar o método de pagamento GPO.

O objeto é devolvido como customMetadata nas respostas de detalhe e listagem de pagamentos. Não inclua credenciais, dados de cartão, tokens de acesso ou outros segredos.

Comportamento da referência PPR. Dynamic é uma referência de montante fixo e exige amount superior a zero. Charging é reutilizável e pode receber múltiplas transações; utilize amount: 0 quando o pagador deve escolher o montante. Assume Dynamic quando omitido.

Data de expiração ISO 8601 opcional. Quando omitida, uma referência dinâmica expira um mês após a criação e uma referência charging assume o final de 2099.

Motivo ou designação da referência definido pelo comerciante.

Email opcional do cliente, guardado com a referência e devolvido na resposta do pagamento PPR.

Nome opcional do cliente, guardado com a referência e devolvido na resposta do pagamento PPR.

Número de telefone opcional do cliente, devolvido na resposta do pagamento PPR.

Número opcional do documento de identificação do cliente, devolvido nos detalhes do pagamento.

Objeto JSON opcional definido pelo comerciante para associar o pagamento PPR aos seus registos internos.

O comerciante escolhe os nomes das propriedades. Os valores podem ser strings, números, booleanos, arrays, objetos aninhados ou null. Estes valores não afetam a entidade, referência, montante, expiração ou estado do pagamento.

Envie este objeto como metadata.custom ao utilizar POST /api/payments. A IZI Pay guarda-o e devolve-o na propriedade de topo customMetadata nas respostas de criação e consulta PPR. Não inclua credenciais, dados de cartão, tokens de acesso ou outros segredos.

Referência PPR opcional, definida pelo comerciante, com 9 a 15 dígitos. Omita para gerar automaticamente.

Dynamic cria uma referência de montante fixo. Charging cria uma referência reutilizável e permite montante aberto. Assume Dynamic quando omitido.

Obrigatório e superior a zero para Dynamic; opcional para Charging, onde 0 representa um montante aberto.

Data futura de expiração opcional no formato ISO 8601.

Motivo ou designação opcional da referência, visível ao comerciante.

Email opcional do cliente, guardado com a referência.

Nome completo opcional do cliente, guardado com a referência.

Número de telefone opcional do cliente, guardado com a referência.

Número opcional do documento de identificação do cliente, guardado com a referência.

Objeto JSON opcional definido pelo comerciante para reconciliação interna e associação de registos.

Esta é a forma utilizada pelos endpoints PPR diretos: envie customMetadata na raiz do pedido para POST /api/references/ppr, /api/references/ppr/legacy e em cada item de /api/references/ppr/bulk. Não envolva este campo em metadata ou custom.

Os nomes das propriedades são escolhidos pelo comerciante. Os valores podem ser strings, números, booleanos, arrays, objetos aninhados ou null. Os valores não afetam o processamento PPR e são devolvidos sem alteração como customMetadata nas respostas de criação, detalhe e listagem.

Não inclua credenciais, dados de cartão, tokens de acesso ou outros segredos.

Nas respostas PPR compactas, identifica o registo da referência PPR. Utilize reference, e não este campo, em GET /api/payments/{paymentId}.

Identificador interno do pagamento, quando incluído pelo fluxo selecionado.

Referência do provedor/pagamento. Para PPR, utilize este valor para consultar os detalhes.

Objeto 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.

Objeto 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.

Objeto 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.

Identificador da transação.

Número de log do sistema associado à notificação de pagamento.

Identificador de período/log do sistema.

Data e hora em que o pagamento do cliente foi registado.

Montante pago pelo cliente.

Tipo de terminal usado no pagamento.

Identificador do terminal.

Localidade do terminal.

Referência de pagamento paga pelo cliente.

Identificador único da notificação. Use este valor para idempotência.

NIB da conta debitada, quando disponível.

Nome do banco, quando disponível.

Data e hora em que a transação QR Code foi criada.

Data e hora em que o estado da transação QR Code foi atualizado.

Identificador único da transação no provedor. Use este valor para idempotência.

Montante pago pelo cliente.

Período de compensação associado à transação.

Número da transação no provedor.

Estado do pagamento QR Code.

Tipo da transação.

Origem da ordem de pagamento.

Moeda do pagamento.

Número de referência do comerciante associado ao pagamento QR Code.

Devolva true quando a notificação for processada com sucesso ou já tiver sido processada antes.

Nota curta sobre o processamento.

Identificador interno do pagamento no sistema do comerciante.

Sender name configured for SMS messages.

Current available SMS units.

Ledger entry type, such as credit or debit.

Destination phone number in the format accepted by the SMS service.

SMS template identifier.