createDepositOrder
Creates aDEPOSIT order for a direct on-chain deposit to a recipient address.
params (OrderParams), opts?Returns:
Promise<APIResponse<Order>>
createSaleOrder
Creates aSALE order for a merchant checkout. It requires your API secret and must run on the server.
currency and recipient are omitted, CoinVoyage settles to your dashboard settlement configuration.
Parameters: params (OrderParams), apiSecret (string), opts?Returns:
Promise<APIResponse<Order>>
createRefundOrder
Creates aREFUND order against an existing completed order.
orderId, params (RefundRequest), apiSecret, opts?Returns:
Promise<APIResponse<Order>>
getOrder
Promise<APIResponse<Order>>
listOrders
Lists orders for your organization. This is a signed server-side method.Promise<APIResponse<OrdersWithPagination>>
getOrderPaymentMethods
Promise<APIResponse<PaymentMethodsResponse>>
orderQuotes
Generates ranked quote options for paying an order from a wallet or explicit source list.Promise<APIResponse<OrderQuotesResponse>>
createPayment
Creates payment instructions for an order. Destination and amount come from the order; the request supplies the funding source.Promise<APIResponse<PaymentResponse>>
x402Complete
Completes an x402 payment. IfpaymentSignature is omitted, the API returns a 402 response with a PAYMENT-REQUIRED header.
Promise<APIResponse<void>>
Recover a Pay to Address partial payment
When a Pay to Address payment reachesPARTIAL_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.