SwichPayApiException class

Thrown when the SwichPay API returns an error response.

Inheritance

Constructors

SwichPayApiException(String message, {required int statusCode, String? code, String? serverMessage, String? serverStatus, String? orderId})

Properties

code → String?
final
hashCode → int
The hash code for this object.
no setterinherited
isPending → bool
no setter
message → String
Technical detail for logs/debugging - may include URLs, HTTP codes or field names, so never show it to end users; use userMessage for that.
finalinherited
orderId → String?
The response body's orderId, when the server created an order before erroring.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverMessage → String?
The response body's own message (e.g. "Invalid OTP."), when the server sent one - meant for the user, unlike message, which can be an SDK-internal or field-level description.
final
serverStatus → String?
The response body's own status (e.g. "failed", "pending") - a 4xx isn't always a decline: direct card payments answer a vendor-side pending with HTTP 400 + "pending".
final
statusCode → int
final
userMessage → String
Short, non-technical text safe to show to the paying user.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited