CardPaymentSessionResponse

CardPaymentSessionResponse object

Response object specific to card payment sessions, extending PaymentsSessionResponseSchema with card-specific details including card country, institution, type, hashed PAN, and 3D Secure status.

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.
cardCountrystringrequiredCountry of origin for the card used in the transaction.
cardInstitutionstringrequiredFinancial institution that issued the card.
cardTypestringrequiredType of card used (e.g., Visa, Mastercard).
panHashedstringrequiredHashed version of the Primary Account Number (PAN) for security.
threeDStatusstringrequired3D Secure authentication status for the card transaction.
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: