Capxul Docs
API referenceOfframp

Get an offramp quote

Offramp quotes are not currently available; the method returns NOT_IMPLEMENTED.

client.offramp.quote

Offramp quotes are 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 input: OfframpQuoteInput;

const result = await client.offramp.quote(input);

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

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

Signature

client.offramp.quote(input: OfframpQuoteInput, options?: { readonly signal?: AbortSignal; }): Promise<CapxulResult<OfframpQuote>>;

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

Parameters

input

Required.

OfframpQuoteInput;

Prop

Type

options

Optional.

{ readonly signal?: AbortSignal; } | undefined

Returns

Promise<CapxulResult<OfframpQuote>>;

Read the ok discriminant before accessing value or error.

Errors

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. Its TypeScript shape does not imply a working offramp rail.

On this page