Get offramp status

client.offramp.status

Offramp status is not currently available; the method returns NOT_IMPLEMENTED.

Not available

The method is published for contract stability, but the operation currently returns NOT_IMPLEMENTED.

Import and client prerequisite

import { createCapxulClient } from "@capxul/sdk";

const created = await createCapxulClient({
  publishableKey: "cap_pk_…",
});

if (!created.ok) throw created.error;
const client = created.value;

Current behavior

declare const offrampId: string;

const result = await client.offramp.status(offrampId);

if (result.ok) {
  throw new Error("This operation is not expected to succeed");
}

console.log(result.error.code); // "NOT_IMPLEMENTED"

Signature

client.offramp.status(offrampId: string, options?: { readonly signal?: AbortSignal; }): Promise<CapxulResult<OfframpStatus>>;

Source: packages/sdk/src/surface/money.ts:830.

Parameters

`offrampId`

Required.

string;

`options`

Optional.

{ readonly signal?: AbortSignal; } | undefined

Returns

Promise<CapxulResult<OfframpStatus>>;

Read the ok discriminant before accessing value or error.

Expected failures resolve as { ok: false, error: CapxulError }; they are not thrown as the normal domain contract. Branch on result.ok and use the stable error.code. A pre-aborted AbortSignal returns a CANCELLED failure. Provider messages and internal causes are not public contracts.

Availability and evidence

Not available. Evidence classification: shipped-proven.

shipped-proven negative contract: this method returns NOT_IMPLEMENTED. No durable offramp operation is created by calling it.

No dedicated React SDK hook currently projects this method.
Platform capability matrix
Core SDK scaffold inventory
Result and proof boundaries