API endpoints for receiving deposits
A Pay-In is when funds are sent from a payer to a merchant’s Orbital account. Pay-Ins allow you to accept cryptocurrency deposits from customers, partners, or other external sources, and either settle them in the same currency or automatically convert to a supported fiat currency before settlement.
Orbital offers five Pay-In methods, each designed for different integration styles, user experiences, and operational needs:
- Rapid Deposit – Generate a reusable wallet address per currency/network.
- Hosted Payment Page (HPP) – Fully hosted by Orbital, no frontend development needed.
- Embedded Payment Page (EPP) – Orbital’s HPP embedded into your platform via a JavaScript widget. Keeps users on your site without full UI build.
- Self-Hosted Invoice UI – Full UI control using Orbital’s APIs. Best for platforms needing complete branding and UX ownership.
- Receive-by-Link (RBL) – Create a manual, one-off deposit link in the Orbital Client Portal. Best for VIP or concierge-style payments.
Choosing the Right Method
| Method | Description | Best For | Implementation Notes |
|---|---|---|---|
| Rapid Deposit | Generates a reusable deposit address via API for a specific currency/network. | Wallet apps, exchanges, gaming platforms, or services with regular top-ups. | No expiry; merchant must store and map addresses to the correct users. |
| Hosted Payment Page (HPP) | Redirect users to Orbital’s fully hosted deposit page where wallet selection, QR code display, and transaction tracking are handled by us. | Merchants wanting to go live quickly with minimal development effort. | Invoice link expires after 15 minutes; limited UI customisation. |
| Embedded Payment Page (EPP) | Embed our hosted flow directly into your site via JS widget, so customers complete deposits without leaving your platform. | Platforms that want improved UX over redirects without building a full UI. | Invoice link expires after 15 minutes; requires JS widget configuration. |
| Self-Hosted Invoice UI | Use Orbital’s API to generate invoice data and build your own frontend for wallet/QR display and payment handling. | Businesses with complex UX, KYC flows, or strict branding requirements. | Invoice link expires after 15 minutes; full frontend development required. |
| Receive-by-Link (RBL) | Manually create and send a one-off hosted invoice link from the Client Portal. No API integration. | VIP, private client, or concierge-style payment flows. | Invoice link expires after 15 minutes; no API support or automation. |
For full feature breakdowns, example flows, and best-practice guidance for each method, see the Pay-Ins section in the Knowledge Base.
How the Pay-Ins API Works
- Create a deposit request using one of the available Pay-In methods.
- Orbital generates either a wallet address or a payment page/invoice link.
- The payer sends funds to the provided address.
- Orbital monitors the blockchain and sends a webhook notification when a valid deposit is detected.
- Your system updates the transaction record and credits the user once payment status is confirmed.
Integration Considerations
- Webhooks are required for real-time payment status updates. Avoid relying solely on API polling.
- Travel Rule compliance may apply, depending on the payer’s location, transaction value, and your account’s regulated entity (
PPOUorPPDL). If required, additional payer details must be included in your deposit request. See Travel Rule Compliance. - Reporting APIs can be used to reconcile Pay-Ins, verify credited amounts, and track incoming transactions.
- Invoice expiry applies to some methods (HPP, EPP, Self-Hosted Invoice UI, RBL). Rapid Deposit addresses do not expire.
Compliance ReminderTravel Rule data must be included for applicable transactions or the payment will be blocked until the required information is provided.