Class OffRamp

Convert crypto to fiat and pay out to a bank account (scopes: payouts:write to withdraw, payouts:read to read).

Index

Constructors

constructor

Methods

banks countries orders quote registerBank removeBank submitBankMaterials withdraw

Constructors

constructor

new OffRamp(c: Requester): OffRamp
Parameters
- c: Requester
Returns OffRamp
- Defined in src/resources/offramp.ts:67

Methods

banks

banks(): Promise<Page<Record<string, unknown>>>
List the workspace's registered bank accounts (use an id as OffRampWithdrawParams.bankAccountId).

Returns Promise<Page<Record<string, unknown>>>
The raw { items, nextCursor } (nextCursor always null) of bank-account records.

Throws
On failure (e.g. 401/403 missing payouts:read).
- Defined in src/resources/offramp.ts:82

countries

countries(): Promise<Page<Record<string, unknown>>>
List supported off-ramp destination countries.

Returns Promise<Page<Record<string, unknown>>>
The raw { items, nextCursor } (nextCursor always null) of country records.

Throws
On failure (e.g. 401/403 missing payouts:read).
- Defined in src/resources/offramp.ts:74

orders

orders(
query?: PageQuery & { q?: string; status?: OffRampOrderStatus },
): Promise<Page<Record<string, unknown>>>
List off-ramp orders (scope: payouts:read). Keyset-paginated.
Parameters
- query: PageQuery & { q?: string; status?: OffRampOrderStatus } = {}
  Filters + pagination; pass a prior page's nextCursor as before.
  - Optionalq?: string
    Optional free-text search.
  - Optionalstatus?: OffRampOrderStatus
    Optional OffRampOrderStatus filter.
Returns Promise<Page<Record<string, unknown>>>
The raw { items, nextCursor } page of off-ramp order records.

Throws
On failure (e.g. 401/403 missing payouts:read).
- Defined in src/resources/offramp.ts:145

quote

quote(params: OffRampQuoteParams): Promise<Record<string, unknown>>
Get a firm off-ramp quote (crypto amount → fiat amount + rate/fees). No funds move.
Parameters
- params: OffRampQuoteParams
  What to sell; see OffRampQuoteParams.
Returns Promise<Record<string, unknown>>
The quote payload (includes a quoteToken to pass to OffRamp.withdraw).

Throws
On failure (e.g. 422 below minimum, 401/403 auth).
- Defined in src/resources/offramp.ts:124

registerBank

registerBank(params: BankRequest): Promise<Record<string, unknown>>
Register a fiat bank account as an off-ramp destination (scope: payouts:write). Subject to manual review.
Parameters
- params: BankRequest
  The bank details + a supporting document; see BankRequest.
Returns Promise<Record<string, unknown>>
The registered bank { bankAccountId, status, ... }.

Throws
On failure (e.g. 422 invalid details, 401/403 missing payouts:write).
- Defined in src/resources/offramp.ts:91

removeBank

removeBank(bankAccountId: string): Promise<void>
Delete a registered bank account (scope: payouts:write).
Parameters
- bankAccountId: string
  Id of the bank account to remove (from OffRamp.banks).
Returns Promise<void>
Nothing on success.

Throws
On failure (e.g. 404 unknown bank, 401/403 missing payouts:write).
- Defined in src/resources/offramp.ts:100

submitBankMaterials

submitBankMaterials(
bankAccountId: string,
params: { certificate: DocFile[]; passport: DocFile[] },
): Promise<Record<string, unknown>>
Upload verification materials for a registered bank account (scope: payouts:write).
Parameters
- bankAccountId: string
  Id of the bank account the documents belong to (from OffRamp.banks).
- params: { certificate: DocFile[]; passport: DocFile[] }
  The verification documents (each a base64 DocFile).
  - certificate: DocFile[]
    One or more certificate documents.
  - passport: DocFile[]
    One or more passport/identity documents.
Returns Promise<Record<string, unknown>>
The updated bank verification payload.

Throws
On failure (e.g. 404 unknown bank, 422 invalid document, 401/403 missing payouts:write).
- Defined in src/resources/offramp.ts:112

withdraw

withdraw(
params: OffRampWithdrawParams,
opts?: IdempotencyOptions,
): Promise<Record<string, unknown>>
Execute an off-ramp withdrawal against a quote, settling fiat to a bank account (scope: payouts:write).
Parameters
- params: OffRampWithdrawParams
  The withdrawal; see OffRampWithdrawParams. Amounts must match the quote.
- opts: IdempotencyOptions = {}
  Optional { idempotencyKey } — retrying with the same key + body replays the original.
Returns Promise<Record<string, unknown>>
The created off-ramp order payload.

Throws
On failure (e.g. 409/422 expired quote, 422 insufficient balance, 401/403 auth).
- Defined in src/resources/offramp.ts:134

Class OffRamp

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns OffRamp

Methods

banks

Returns Promise<Page<Record<string, unknown>>>

Throws

countries

Returns Promise<Page<Record<string, unknown>>>

Throws

orders

Parameters

Optionalq?: string

Optionalstatus?: OffRampOrderStatus

Returns Promise<Page<Record<string, unknown>>>

Throws

quote

Parameters

Returns Promise<Record<string, unknown>>

Throws

registerBank

Parameters

Returns Promise<Record<string, unknown>>

Throws

removeBank

Parameters

Returns Promise<void>

Throws

submitBankMaterials

Parameters

certificate: DocFile[]

passport: DocFile[]

Returns Promise<Record<string, unknown>>

Throws

withdraw

Parameters

Returns Promise<Record<string, unknown>>

Throws

Settings

On This Page

`Optional`q?: string

`Optional`status?: OffRampOrderStatus