API Reference

Integrate XRPay directly into your application backend. Use the interactive console below to test our endpoints in real-time.

Select Endpoint

POST/api/v1/checkout

Create Checkout Session

Creates a new payment session and returns a hosted checkout URL along with QR code data. Supports the Universal On-Ramp API — specify settlement currency and destination address per request.

Authentication

Authenticate your requests by including your API key. Test keys start with pk_test_ or sk_test_.

Required Key Type: Publishable Key (pk_test_... or pk_live_...)

Parameters

Parameter	Description
`apiKey`Required string	Your organization's API key (can also be passed in body for this endpoint).
`amount`Required number	The fiat amount to charge (e.g., 10.50). Must be positive.
`currency`Required string	Three-letter fiat currency code (e.g., USD, EUR).
`orderId`Optional string	Your internal system's order identifier.
`customerEmail`Optional string	Email address to pre-fill on checkout.
`settlementCurrency`Optional string	XRPL token to settle in. "XRP" or "RLUSD". Defaults to your org setting.
`destinationAddress`Optional string	Customer's XRPL r-address for direct settlement. Overrides org wallet.
`skipTrustlineCheck`Optional boolean	If true, skips the XRPL trustline pre-check. Use if you pre-validate trustlines.
`callbackUrl`Optional string	URL to redirect the customer after payment completes.
`metadata`Optional object	Arbitrary key-value pairs to attach to the session (returned in webhooks).

API Key (Header / Body)

Passed as Bearer token automatically.

Request Body (JSON)