PayFanout API reference
    Preparing search index...

    Class PayFanoutError

    Hierarchy

    • Error
      • PayFanoutError

    Implements

    Index
    cause?: unknown
    message: string

    Safe to show to end users.

    name: string
    pspName?: string
    raw: unknown

    Untouched original PSP error, for logs/support — never dropped.

    retryable: boolean
    stack?: string
    stackTraceLimit: number

    The 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.

    • Returns {
          code: UnifiedErrorCode;
          message: string;
          name: string;
          pspName?: string;
          retryable: boolean;
      }

    • Creates 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();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

    • Normalizes any thrown value into a PayFanoutError. Existing PayFanoutErrors pass through unchanged (so raw and code set close to the PSP win); anything else becomes code: "unknown" (unless the fallback says otherwise) with the original value on raw. The wrapped error's own message is never copied into message — it is user-facing and arbitrary error text can leak internals — so absent fallback.message the built-in user-safe catalog message for the code is used instead.

      Parameters

      Returns PayFanoutError