Errors

{
  "error": {
    "message": "The supplied customer was not found.",
    "param": "customer",
    "type": "invalid_request"
  },
  "status": 404
}

Yorlet uses conventional HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with Yorlet’s servers.

Attributes

errorobject
The error object.
error.messagestring
A human-readable message providing more details about the error.
error.paramstring
If the error is parameter-specific, the parameter related to the error.
error.typestring
The type of error returned.
statusinteger
The status code.

Error code	Meaning
`400` Bad Request	The request was unacceptable, often due to missing a required parameter.
`401` Unauthorized	No valid API key was provided.
`403` Forbidden	The API key doesn’t have permissions to perform the request.
`404` Not Found	The requested resource doesn’t exist.
`429` Too Many Requests	Too many requests hit the API too quickly.
`5XX` Server Error	We had a problem with our server. Try again later.

Yorlet API

Billing

Checkout

Core

Guardrails

Leads

Leasing

Loyalty

Owners

Payments

Terminal

Test Helpers

Attributes

​Attributes

Attributes