Referências

Server

Referência para pagamento na rede multicaixa. É possível obter detalhes e cancelar uma referência, verificar o histórico de pagamento e alterações, verificar a existência de uma referência, bem como listar todas as referências. As referências são identificadas por um ID único e aleatório.

Listar todas referências

GET

https://pay-sandbox.izipay.ao

/v1/referencias

Authorization (header)

Lista de referências criadas anteriormente. As referências são retornadas de forma ordenada, com as referências mais recentes primeiro.

Listar todas referências › query Parameters

page

integer

Número de páginas a mostar

Default: 1

pageSize

integer

Número de itens a mostar por cada página

Default: 50

estado

string · enum

Estado da referência

Enum values:

válida

cancelada

paga

expirada

referencia

integer

Número da referência

Listar todas referências › Responses

GET/v1/referencias

curl --request GET \
  --url https://pay-sandbox.izipay.ao/v1/referencias

Example Responses

{
  "result": [
    {
      "pago": "0,00",
      "montante": "10 000,00",
      "emissao": "01/01/2020 00:00",
      "validade": "31/12/2020 23:59",
      "numero": "100100100",
      "tipo": "Fixa",
      "estado": "Válida",
      "entidade": {
        "nome": "entidade",
        "numero": "xxxxx"
      },
      "cliente": {
        "nome": "John Doe",
        "email": "john.doe@domain.xx",
        "telefone": "900000000"
      },
      "id": "00000000-0000-0000-0000-000000000000"
    },
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "currentPage": 1,
  "pageSize": 10,
  "rowCount": 60,
  "firstRowOnPage": 1,
  "lastRowOnPage": 10
}

json

application/json

Criar uma referência

POST

https://pay-sandbox.izipay.ao

/v1/referencias

Authorization (header)

Cria de uma referência para pagamento no multicaixa.

Criar uma referência › Request Body

numero

string | null · pattern: ^[0-9]$

Número da referência. Caso nulo o sistema cria um número para a referência.

validade

string | null · d/m/Y H:i

Data de validade da referência.

Default: 01/01/2099 00:00

montante

string · decimal (fi-FI)

Montante a pagar. required para referências dinâmicas. Exemplo: 99 999,99

cliente

object | null

Dados para notificação do cliente.

metadados

object | null

Objecto chave/valor utilizado para armazenar informações adicionais sobre o pedido. A chave e o valor deverão ser strings.

Criar uma referência › Responses

Created

POST/v1/referencias

curl --request POST \
  --url https://pay-sandbox.izipay.ao/v1/referencias \
  --header 'Content-Type: application/json' \
  --data '
{
  "numero": "123456789",
  "validade": "31/12/2020 23:59",
  "montante": "10 000,00",
  "cliente": {
    "nome": "John Doe",
    "email": "john.doe@domain.xx",
    "telefone": "900000000"
  },
  "metadados": {
    "item1": "1",
    "item2": "teste"
  }
}
'

Example Request Body

{
  "numero": "123456789",
  "validade": "31/12/2020 23:59",
  "montante": "10 000,00",
  "cliente": {
    "nome": "John Doe",
    "email": "john.doe@domain.xx",
    "telefone": "900000000"
  },
  "metadados": {
    "item1": "1",
    "item2": "teste"
  }
}

json

Example Responses

{
  "pago": "0,00",
  "montante": "10 000,00",
  "emissao": "01/01/2020 00:00",
  "validade": "31/12/2020 23:59",
  "numero": "123456789",
  "tipo": "Fixa",
  "estado": "Válida",
  "entidade": {
    "nome": "entidade",
    "numero": "00000"
  },
  "cliente": {
    "nome": "John Doe",
    "email": "john.doe@domain.xx",
    "telefone": "900000000"
  },
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

Detalhar uma referência

GET

https://pay-sandbox.izipay.ao

/v1/referencias/{id}

Authorization (header)

Detalhes de uma referência que foi criada anteriormente. Forneça o ID exclusivo da referência que foi retornado na requisição anterior e a IZI Pay retornará as informações da referência correspondente. A mesma informação é retornada ao gerar a referência.

Detalhar uma referência › path Parameters

id

string · uuid · required

ID único da referência

Detalhar uma referência › Responses

Cancelar uma referência

DELETE

https://pay-sandbox.izipay.ao

/v1/referencias/{id}

Authorization (header)

Elimine uma referência válida. Forneça o ID da referência exclusivo que foi retornado na requisição anterior e a IZI Pay cancelará a referência. Uma referência cancelada deixa de estar disponível para pagamento.

Cancelar uma referência › path Parameters

id

string · required

ID único da referência

Cancelar uma referência › Responses

No Content

No data returned

Histórico de uma referência

GET

https://pay-sandbox.izipay.ao

/v1/referencias/{id}/historico

Authorization (header)

Lista operações realizadas sobre a referência. Forneça o ID exclusivo da referência e a IZI Pay retornará o histórico de operações correspondentes a referência.

Histórico de uma referência › path Parameters

id

string · uuid · required

ID único da referência

Histórico de uma referência › Responses

Verificar uma referência

GET

https://pay-sandbox.izipay.ao

/v1/referencias/{numero}/testar

Authorization (header)

Verifique se um número de referência já existe na sua rede multicaixa.

Verificar uma referência › path Parameters

numero

string · number · minLength: 9 · maxLength: 9 · required

Número da refrência

Verificar uma referência › Responses

Pagamentos

Listar todas referências

GET

https://pay-sandbox.izipay.ao

/v1/referencias

Authorization (header)

Lista de referências criadas anteriormente. As referências são retornadas de forma ordenada, com as referências mais recentes primeiro.

Listar todas referências › query Parameters

page

integer

Número de páginas a mostar

Default: 1

pageSize

integer

Número de itens a mostar por cada página

Default: 50

estado

string · enum

Estado da referência

Enum values:

válida

cancelada

paga

expirada

referencia

integer

Número da referência

Listar todas referências › Responses

Criar uma referência

POST

https://pay-sandbox.izipay.ao

/v1/referencias

Authorization (header)

Cria de uma referência para pagamento no multicaixa.

Criar uma referência › Request Body

numero

string | null · pattern: ^[0-9]$

Número da referência. Caso nulo o sistema cria um número para a referência.

validade

string | null · d/m/Y H:i

Data de validade da referência.

Default: 01/01/2099 00:00

montante

string · decimal (fi-FI)

Montante a pagar. required para referências dinâmicas. Exemplo: 99 999,99

cliente

object | null

Dados para notificação do cliente.

metadados

object | null

Objecto chave/valor utilizado para armazenar informações adicionais sobre o pedido. A chave e o valor deverão ser strings.

Criar uma referência › Responses

Created

Detalhar uma referência

GET

https://pay-sandbox.izipay.ao

/v1/referencias/{id}

Authorization (header)

Detalhar uma referência › path Parameters

id

string · uuid · required

ID único da referência

Detalhar uma referência › Responses

Cancelar uma referência

DELETE

https://pay-sandbox.izipay.ao

/v1/referencias/{id}

Authorization (header)

Cancelar uma referência › path Parameters

id

string · required

ID único da referência

Cancelar uma referência › Responses

No Content

No data returned

Histórico de uma referência

GET

https://pay-sandbox.izipay.ao

/v1/referencias/{id}/historico

Authorization (header)

Lista operações realizadas sobre a referência. Forneça o ID exclusivo da referência e a IZI Pay retornará o histórico de operações correspondentes a referência.

Histórico de uma referência › path Parameters

id

string · uuid · required

ID único da referência

Histórico de uma referência › Responses

Verificar uma referência

GET

https://pay-sandbox.izipay.ao

/v1/referencias/{numero}/testar

Authorization (header)

Verifique se um número de referência já existe na sua rede multicaixa.

Verificar uma referência › path Parameters

numero

string · number · minLength: 9 · maxLength: 9 · required

Número da refrência