payment_url.
Headers
Your active Vanryx API key. See API keys and authentication.
Optional. 1 to 255 visible ASCII characters. See Idempotency.
Body parameters
Invoice price. Must be numeric and greater than zero. Send it as a JSON string to preserve decimal precision, for example
"49.95".Fiat currency of the invoice price. If omitted or empty, defaults to
USD. Maximum 16 characters. Must match an active configured fiat currency.Whether the payer bears the service-fee gross-up under the Vanryx invoice rules.
URL that receives webhook callbacks for this invoice. Maximum 2,048 characters. Must use HTTP or HTTPS and resolve only to public IP addresses.
Unsupported fields and capabilities
The request schema accepts the boolean fieldssandbox, mixed_payment, and auto_withdrawal, but these invoice capabilities are unavailable. If any of them is true, the request is rejected. Leave them out of your requests.
Idempotency
TheIdempotency-Key header is optional.
- If you reuse a key with equivalent normalized request data, Vanryx returns the original invoice response.
- If you reuse a key with different request data, Vanryx returns HTTP
409with codeIDEMPOTENCY_KEY_REUSED.
Response
Payment options
Send the payer topayment_url. The payer selects a currency and network on that page.
Not every currency is available for every invoice. Eligible options depend on current configuration, Merchant account readiness, rate availability, and minimums. Existing invoice quotes are retained.
Errors
See Errors and integration notes.