HomeAPI ReferenceCrypto Payment Orders
API Reference

Crypto Payment Orders

Accept crypto payments from your customers. A payment order is an invoice in fiat (amountInFiat, in your vault's currency) that the customer pays in crypto. Available in payment vaults. Flow: 1) Create the order. 2) If you did not give an assetId, the customer picks a coin and you call Select Asset; RoxCustody then assigns a dedicated receiving wallet and calculates amountInAsset at the current price. 3) The customer pays to the wallet address, or through paymentLink, before expiration. 4) RoxCustody detects the payment and marks the order PAID; you receive the paid_payment_vault_order webhook. Statuses: INITIALIZING (being created), PENDING (waiting for payment), PAID, EXPIRED, CANCELLED, REFUNDED. Order ids: you can give your own id (up to 42 characters); otherwise a ULID is generated.

Endpoints

Was this page helpful?