This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk / ErrorDetailsMap

ErrorDetailsMap ​

Map of details per error code: extend it by declaration merging to type the details of your operator's codes. isEnginexError(e, code) uses this map to narrow e.details — codes without an entry here keep details: unknown. Include | undefined when the gateway may omit the details (as in captcha_required): the type then requires the check.

Example ​

ts
declare module '@getenginex/sdk' {
  interface ErrorDetailsMap {
    MY_CODE: { field: string }
  }
}

Properties ​

captcha_required ​

captcha_required: CaptchaRequiredDetails | undefined

details of captcha_required. May be missing if the gateway does not send the map: read it with e.details?.site_key.