AccessTokenRequest
usernameMerchant user name.
passwordMerchant user password.
AccessTokenResponse
idfirstNamelastNameusernametokenAccess token to send as Authorization: Bearer <token>.
CaptureRequest
amountAmount to capture. Equal to or lower than the authorised amount.
currencyMust match the authorisation currency.
PartialAuthorizationRequest
amountRemaining amount to authorise.
currencymerchantReferenceNumberMerchant reference of the original authorisation.
orderOriginQrCodeChargeRequest
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.
QrCodeRefundRequest
amountAmount to refund. Equal to or lower than the charge amount.
currencysupervisorIdSupervisor of the terminal (supervisorId from Get terminal).
reasonOptional reason for the refund.
RefundRequest
amountAmount to refund. Equal to or lower than the purchase amount.
supervisorCardSupervisor card associated with the terminal.
PaymentRequest
amountAmount to authorise or charge.
currencyISO 4217 currency code.
merchantReferenceNumberUnique merchant reference for this order. Reusing it returns 400 REFERENCE_NUMBER.
Payment method data.
orderOriginOrigin of the order.
DeeplinkChargeRequest
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.
DeeplinkChargeResponse
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.
PointOfSale
creationDateupdatedDateactiveidnamestatusTerminal state.
scenariosupervisorIdClearingPeriod
creationDateupdatedDatereferencestransactionsauthorizedcancelledpayedrefundednumberopenDatecloseDatecommission