Getting Started
Glossary
| Term | Meaning |
|---|---|
| Access-Key | A secret value you choose. IZI Pay sends it in the Access-Key header of every webhook, so your server can check that the notification came from IZI Pay. |
| Access token | A temporary key you get with your client ID and client secret, and send with every request. It expires, so request a new one before it does. See Authentication. |
| Authorization | Reserving an amount on the customer's account without collecting it yet. You then capture it or cancel it. See Authorize Funds. |
| Callback | Another name for a webhook. |
| Capture | Collecting money that an authorization reserved. See Capture Funds. |
| Charging Reference | A Multicaixa reference that can be paid several times, for example to top up an account. Each payment is recorded separately. |
| Client ID and client secret | Your API credentials, used to get an access token. Keep the secret on your server. See Credentials and Support. |
| Deep Link | A link that opens Multicaixa Express directly on a payment, as an alternative to scanning the QR Code on the same phone. |
| Dynamic Reference | A Multicaixa reference for one fixed amount, paid once, with an expiry date. |
| Entity | The number that identifies who is being paid. The customer enters the entity, the reference and the amount to pay at an ATM or in their banking app. |
| GPO | Gateway de Pagamento Online, the online payment gateway behind Multicaixa Express payments, QR Codes and Webframe. It appears in API values such as paymentType: GPO. |
| GPO merchant ID, POS ID and user email | The details that identify your merchant account, your payment terminal and your user at the GPO. The plugins need them for Payment Requests and QR Codes. |
| Idempotency key | A unique value you send with a new payment (metadata.idempotencyKey). If you retry with the same key, IZI Pay returns the existing payment instead of creating a second one. |
internalId | IZI Pay's identifier for a payment. Use it to look up, sync or cancel that payment. |
| Multicaixa Express | The Angolan mobile payment app. Customers use it to approve Payment Requests and to scan QR Codes. |
| Multicaixa Reference | An entity and reference number the customer pays at an ATM or in their banking app. Also called a payment reference. See Payment References. |
| Payment Request | A payment the customer receives and approves on their phone, in Multicaixa Express. In the API it's the onetimepurchase method. |
| POS ID | The identifier of the payment terminal (point of sale) your payments go through. |
| PPR | Pagamento por Referência: payment by reference. It appears in API values such as paymentType: PPR. |
| Production | The live environment, where real money moves. See Environments. |
| Reference | Two different things: your own reference for a payment, such as an order number, and the Multicaixa reference number a customer pays. |
| Sandbox | The test environment. It works like production, but no real money moves. See Environments. |
| Status | Where a payment is in its life, such as Pending or Completed. See Payment Statuses. |
| Supervisor ID | Identifies an authorized supervisor. Needed to refund Payment Requests and to open or close terminals. |
| Terminal | A payment terminal (POS) assigned to your account. See Terminal Operations. |
| Webframe | A payment page hosted by the provider. You send the customer to its address (paymentUrl) to pay. |
| Webhook | A notification IZI Pay sends to your server when a payment is confirmed. See Webhooks. |
Last modified on