PaymentsSessionResponse
PaymentsSessionResponse object
Response object returned by payment session lifecycle events, containing transaction details, status, error information, and session metadata.
| Property | Type | Required | Description |
|---|---|---|---|
acquirerDateTime | string | required | Date and time of the transaction from the acquirer’s perspective. |
amount | string | required | Transaction amount. |
countryCode | string | required | Country code for the transaction. |
currencyCode | string | required | Currency code for the transaction amount. |
locale | string | required | Locale used for the transaction. |
merchantReference | string | required | Merchant-provided reference for the transaction. |
payMethod | string | required | Payment method used (e.g., Card, Ozow). |
puid | string | required | Unique payment identifier. |
responseToken | string | required | Response token for the payment session. |
result | string | required | Result code of the transaction. |
status | string | required | Current status of the payment session. |
transactionIndex | string | required | Unique transaction identifier. |
txtPrice | string | required | Transaction price in text format. |
uci | string | required | Unique customer identifier. |
bankErrorCode | string | optional | Bank-specific error code if the transaction encountered a bank error. |
bankErrorMessage | string | optional | Bank-specific error message if the transaction encountered a bank error. |
errorCode | string | optional | Error code if the transaction failed. |
errorDetail | string | optional | Detailed error information if the transaction failed. |
errorMessage | string | optional | Human-readable error message if the transaction failed. |
errorSource | string | optional | Source of the error (e.g., gateway, bank, merchant). |