HTTP status code of the response.
Machine-readable error code from the body.
Short human-readable summary; becomes the Error message.
Optionaldetail: stringOptional longer explanation.
OptionalrequestId: stringOptional server request id for correlation.
OptionalcauseThe cause of the error.
ReadonlycodeStable machine-readable error code from the response body (e.g. "insufficient_scope"), or "error" if absent.
ReadonlydetailLonger human-readable explanation of what went wrong, when the API provides one.
ReadonlyrequestServer-assigned request id (from the x-request-id header) — quote it in support tickets.
OptionalstackReadonlystatusHTTP status code of the failed response (e.g. 401, 429, 500).
StaticstackThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
true for HTTP 401/403 — an authentication or authorization failure:
a bad/missing API key, insufficient scope for the operation, or an invalid
request signature. Not retryable without fixing credentials.
true for HTTP 429 (rate limited) — you are sending requests too fast.
Back off and retry after a short delay.
StaticcaptureCreates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
OptionalconstructorOpt: FunctionCreate .stack property on a target object
OptionalconstructorOpt: FunctionStaticisCheck if a value is an instance of Error
The value to check
True if the value is an instance of Error, false otherwise
Staticprepare
Error thrown by every SDK method when the API returns a non-2xx response.
Carries the platform's problem+json fields so you can branch on the failure without re-parsing the body. The AbsolutePayError.message is the human-readable
title(falling back tocode/status). Use AbsolutePayError.isAuth and AbsolutePayError.isRateLimited for the common branches.Example