data class ForageError(val httpStatusCode: Int, val code: String, val message: String, val details: ForageErrorDetails? = null)

A model that represents an error response from the Forage API.

See also

SDK Errors for a comprehensive list of error code and message pairs.


Link copied to clipboard
constructor(httpStatusCode: Int, code: String, message: String, details: ForageErrorDetails? = null)


Link copied to clipboard

A short string that helps identify the cause of the error. For example, ebt_error_55 indicates that a customer entered an invalid EBT Card PIN.

Link copied to clipboard

An object that includes additional details about the error, when available, like for ebt_error_51 (Insufficient Funds).

Link copied to clipboard

A number that corresponds to the HTTP status code that the Forage API returns in response to the request.

Link copied to clipboard

A string that specifies developer-facing error handling instructions.


Link copied to clipboard
open override fun toString(): String

A method that converts the ForageError response to a string.