crisp.createWithdrawal()

Named, typed API method. Uses the shared signing, validation and timeout implementation with one HTTP attempt. No path/query/body wrapper is needed.

funding workflow · All SDK methods

Import and runtime

@crisp-trade/partner-sdk — server only; never expose credentials to the browser.

Client setup and shared behavior

Arguments

Argument	Presence	Released TypeScript type
`externalUserId`	Required	`Operations["createWithdrawal"]['input']['path']["externalUserId"]`
`input`	Required	`Operations["createWithdrawal"]['input']['body']`
`idempotencyKey`	Required	`string`
`options`	Optional	`OrderOptions`

Named types are expanded under “Exact released types” below. Parameters are in call order; optional does not imply nullable.

Example

Example IDs and intent keys are illustrative. Replace them with authenticated account resources and your persisted intent. Browser route names are example routes you implement on your own backend.

// Use a reused, server-only CrispClient (see client setup).
const result = await crisp.createWithdrawal(
  'user-123',
  {
    amountBaseUnit: '2000000',
    recipientAddress: 'example',
    toChainId: '137',
    toTokenAddress: 'example',
  },
  'persisted-intent-0001',
);
console.log(result.data, result.status, result.requestId);

Returns

Returns a promise for a typed response wrapper. Inspect data and its state; a resolved request is not necessarily a successful financial outcome.

Return type

Promise<Response<Operations["createWithdrawal"]['data']>>

Errors and lifecycle

Errors and retry policy. Financial uncertainty requires recovery with the original intent, never a new key. Realtime helpers must be stopped on logout/account switch.

POST /v1/accounts/{externalUserId}/withdrawals — createWithdrawal

Exact released types

Extracted from the shipped SDK 0.13.0, not separately maintained signatures.

Full signature

crisp.createWithdrawal(externalUserId: Operations["createWithdrawal"]['input']['path']["externalUserId"], input: Operations["createWithdrawal"]['input']['body'], idempotencyKey: string, options?: OrderOptions): Promise<Response<Operations["createWithdrawal"]['data']>>

OrderOptions

export type OrderOptions = {
    signal?: AbortSignal;
    traceId?: string;
};

Response

export interface Response<T> {
    data: T;
    status: number;
    requestId: string;
    retryAfterMs: number | null;
    asOf?: string | null;
    freshness?: string | null;
}

Related type

// Operations["createWithdrawal"]
{
        input: {
            "path": {
                "externalUserId": string;
            };
            "body": {
                "amountBaseUnit": string;
                "recipientAddress": string;
                "toChainId": string;
                "toTokenAddress": string;
            };
            "idempotencyKey": string;
        };
        data: {
            "crispAccountId": string;
            "externalUserId": string;
            "withdrawal": {
                "id": string;
                "amountBaseUnit": string;
                "recipientAddress": string;
                "toChainId": string;
                "toTokenAddress": string;
                "bridgeAddress": string | null;
                "state": "queued" | "submitting" | "submitted" | "confirmed" | "failed" | "manual_review";
                "relayTransactionId": string | null;
                "transactionHash": string | null;
                "failureCode": string | null;
                "finalDestinationStatus": string | null;
                "createdAt": string;
                "updatedAt": string;
                "submittedAt": string | null;
                "confirmedAt": string | null;
            };
        };
    }