PaymentsSessionResponse

PaymentsSessionResponse object

Response object returned by payment session lifecycle events, containing transaction details, status, error information, and session metadata.

PropertyTypeRequiredDescription
acquirerDateTimestringrequiredDate and time of the transaction from the acquirer’s perspective.
amountstringrequiredTransaction amount.
countryCodestringrequiredCountry code for the transaction.
currencyCodestringrequiredCurrency code for the transaction amount.
localestringrequiredLocale used for the transaction.
merchantReferencestringrequiredMerchant-provided reference for the transaction.
payMethodstringrequiredPayment method used (e.g., Card, Ozow).
puidstringrequiredUnique payment identifier.
responseTokenstringrequiredResponse token for the payment session.
resultstringrequiredResult code of the transaction.
statusstringrequiredCurrent status of the payment session.
transactionIndexstringrequiredUnique transaction identifier.
txtPricestringrequiredTransaction price in text format.
ucistringrequiredUnique customer identifier.
bankErrorCodestringoptionalBank-specific error code if the transaction encountered a bank error.
bankErrorMessagestringoptionalBank-specific error message if the transaction encountered a bank error.
errorCodestringoptionalError code if the transaction failed.
errorDetailstringoptionalDetailed error information if the transaction failed.
errorMessagestringoptionalHuman-readable error message if the transaction failed.
errorSourcestringoptionalSource of the error (e.g., gateway, bank, merchant).
On this page: