Skip to main content
Order methods cover the complete server-side payment lifecycle. See Core types for the request and response shapes used below.

createDepositOrder

Creates a DEPOSIT order for a direct on-chain deposit to a recipient address.
Parameters: params (OrderParams), opts?
Returns: Promise<APIResponse<Order>>

createSaleOrder

Creates a SALE order for a merchant checkout. It requires your API secret and must run on the server.
If currency and recipient are omitted, CoinVoyage settles to your dashboard settlement configuration. Parameters: params (OrderParams), apiSecret (string), opts?
Returns: Promise<APIResponse<Order>>

createRefundOrder

Creates a REFUND order against an existing completed order.
Parameters: orderId, params (RefundRequest), apiSecret, opts?
Returns: Promise<APIResponse<Order>>

getOrder

Returns: Promise<APIResponse<Order>>

listOrders

Lists orders for your organization. This is a signed server-side method.
Returns: Promise<APIResponse<OrdersWithPagination>>

getOrderPaymentMethods

Returns: Promise<APIResponse<PaymentMethodsResponse>>

orderQuotes

Generates ranked quote options for paying an order from a wallet or explicit source list.
Returns: Promise<APIResponse<OrderQuotesResponse>>

createPayment

Creates payment instructions for an order. Destination and amount come from the order; the request supplies the funding source.
Returns: Promise<APIResponse<PaymentResponse>>

x402Complete

Completes an x402 payment. If paymentSignature is omitted, the API returns a 402 response with a PAYMENT-REQUIRED header.
Returns: Promise<APIResponse<void>>

Recover a Pay to Address partial payment

When a Pay to Address payment reaches PARTIAL_PAYMENT, keep the order unfulfilled and inspect order.payment.funding.remaining_amount. The payer can send one or more additional deposits through the same Pay to Address flow. CoinVoyage records every deposit in funding.transactions and completes the order after the required amount has been received.
Additional-deposit recovery is available only for Pay to Address. Do not assume wallet, card, or other payment methods can resume from PARTIAL_PAYMENT.