Create a QR Code Payment charge that a mobile app can open directly in MULTICAIXA Express.
Create deeplink charge
Creates a QR Code Payment charge and returns a mcxwallet:// URL that opens MULTICAIXA Express directly, so the customer does not need to scan a QR code.
Returning to the merchant app does not confirm payment. Fulfil the order only after the backend transaction notification with status: ACCEPTED. See GPO → Deeplink for the full flow.
This endpoint does not accept an idempotency key. After a timeout or uncertain response, reconcile before retrying.
path Parameters
merchantIdMerchant identifier.
query Parameters
includeQrImageWhen true, the response includes the QR Code image as a Base64 string.
callbackUrlSchemeApplication return URL registered by the merchant mobile app, for example merchantapp://payment-result. MULTICAIXA Express can use it to return control to the app. It is not the server payment-notification URL.
Create deeplink charge › Request Body
amountCharge amount. Must be greater than or equal to 1.
posIdTerminal associated with the merchant.
Optional customer notifications. Any client-supplied notify.callbackUrl is replaced by the callback URL configured by IZI Pay.
Create deeplink charge › Responses
Deeplink charge created.
chargeIdUnique identifier of the created charge.
qrRefComplete QR Code Payment payload. Not the charge ID or the order reference.
deeplinkUrlURL that opens MULTICAIXA Express.
deeplinkUrlWithCallbackDeeplink including the application return URL. Returned only when callbackUrlScheme is supplied.
qrCodeBase64Base64 QR Code image. Returned when includeQrImage=true.
amountreferenceMerchant reference supplied in the request.
Status names recognised by the optional application-return flow.