api.quotes.create
Create a quote request. The server fans out across every eligible rail in parallel. See the Quotes overview for the directionality / fan-out / fee model.
Pass { wait: true } to block until every option has been priced. Default is false, which returns a snapshot id you can poll with quotes.get.
Pass { named: true } to receive only named options, where the payment reaches the beneficiary under the customer's own legal name. Accepting that snapshot then only takes a named option. Without it, every option is returned and each reports is_named.
const = await ..(
{
: "7c4b…",
: "individual",
: "1000",
: { : "USD" },
: "3c92d2a1-…",
},
{ : true },
);
// Or schema-driven: every US-bank rail at once, future-proof. The
// destination object form pins a rail on the payout account.
const = await ..(
{
: "7c4b…",
: "individual",
: "1000",
: { : "USD", : ["us_bank"] },
: { : "3c92d2a1-…", : ["base"] },
},
{ : true },
);| Argument | Type | Notes |
|---|---|---|
req | QuoteRequest | Body shape. See POST /quotes. |
opts.wait? | boolean | true → server blocks until every option has been priced. |
opts.named? | boolean | true → only named options are returned and accepted. |
Returns: Promise<AsyncQuoteSnapshot>.
Throws: ApiError with status: 400 (invalid request) or status: 422 (no eligible options for this corridor, or NoNamedQuote when no eligible route can be named with named: true).
REST endpoint: POST /quotes.