DOCSEARCHbyAlgolia
Submit Docs

Radom API Documentation

website·Indexed 33 days ago

https://docs.radom.com/

API reference for Radom's payment infrastructure, featuring endpoints for payment sessions, payment links, payouts, withdrawals, swaps, and invoices. Includes documentation on open banking, FBO organizations, and webhook events for subscription and withdrawal notifications. All API requests require authentication via the radomToken scheme in the Authorization header.

Tokens
63.1K
Snippets
257
Records
546
Agent score
51%

What's inside Radom

  1. Overview of Radom payment links

    Radom payment links provide a reusable hosted collection page, allowing merchants to accept crypto payments without building a full custom checkout. They are ideal for low-code or no-code crypto collections. Price quotes are generated dynamically during checkout based on the products and currency configuration attached to the link. Activity can be monitored via the Dashboard or automated using webhooks.

  2. Overview of Radom hosted checkout

    Radom hosted checkout allows merchants to launch a customer-facing crypto payment flow where Radom hosts the payment UI and handles quotes. It is recommended for developers who want the shortest path to production while maintaining dashboard visibility and webhook-based reconciliation.

  3. Overview of Radom Open Banking

    Radom Open Banking allows customers or operators to initiate bank payment flows with results tracked inside Radom. It supports customer-facing checkout, merchant treasury funding, and bank-to-crypto product flows. Because open banking is asynchronous, integrations must rely on Radom status reads and webhooks rather than browser redirects for payment confirmation.

  4. Overview of Radom Payouts

    Payouts in Radom are used to disburse funds for merchant settlements, treasury movements, customer operations, or downstream beneficiary payments. The typical flow involves receiving funds (via crypto, open banking, or virtual accounts), reconciling/converting balances, and finally sending disbursements in fiat or crypto.

  5. Handle the `test` webhook event

    The test event is emitted when a webhook endpoint is manually tested via the Radom Dashboard or API. This event allows developers to validate that their endpoint is correctly receiving and processing payloads before going live.

  6. Retrieve a product by ID

    Retrieve detailed information about a specific product using its unique UUID. The request requires a path parameter id (string/uuid) which is mandatory.
    GET /products/{id}

  8. Understand Radom Virtual Accounts for fiat collection

    Virtual accounts are named fiat collection accounts that allow merchants to receive bank-led deposits into Radom. Unlike a shared account model, virtual accounts provide clearer attribution and reconciliation for inbound collections by customer, merchant entity, or specific workflows. They are typically used to map incoming fiat deposits into downstream crypto treasury or payout processes.

  9. Payment Session response object reference

    The payment session response provides detailed information about the transaction, including the total price, currency, session status, and payment address.

    Key fields include:

    • id: Unique UUID of the session.
    • total: Total price to be paid (float, >= 0).
    • currency: The currency used (e.g., USD, BTC, ETH, USDC).
    • sessionStatus: Current state of the session (pending, success, cancelled, expired, refunded).
    • paymentTotal: The exact amount the buyer must send to the payment address.
    • paymentAddress: The destination address for the funds.
    • canExtend: Boolean indicating if the expiration time can be extended.
    • expiresAt: ISO 8601 timestamp when the payment expires.

  10. List payouts using the Payouts API

    Retrieve a list of payouts by providing optional query parameters to filter and paginate the results. The response returns an array of payout objects containing detailed information about crypto and fiat entries, funding details, and payout status.
    // Query Parameters
{
  "isTestMode": boolean,    // Filter by test mode
  "offset": integer,         // Pagination offset
  "limit": integer,          // Pagination limit
  "statuses": "PayoutStatus[]", // Filter by payout statuses (e.g., AwaitingConfirmation, Pending, Processing, Complete, Expired, InReview, Converting, Failed)
  "isMassPayout": boolean    // Filter by mass payout status
}

  11. Understand Radom Product concepts

    Products in Radom represent the goods or services offered to customers. They are reusable entities across hosted checkouts, payment links, invoices, and subscription workflows. Each product is assigned a unique product ID for use in the dashboard and API integrations. Products can support different pricing models: one-time purchases (e.g., ecommerce goods), recurring plans (e.g., SaaS subscriptions), or usage-based billing (e.g., API request volume).

  12. Understand Radom webhook fundamentals

    Radom webhooks send JSON POST requests to a configured endpoint when organization activity occurs. They are used to automate fulfillment, reconciliation, and notifications. Because delivery can be retried, webhook handlers must be idempotent. For open banking checkout sessions, the managedPayment webhook should be used as the trigger for fulfillment, as it may contain openBankingPaymentData with bank rail and final status details.