logo

Documentation

Learn how to integrate OrbitusPay into your application and start accepting crypto payments today.

Authentication

All API requests must include your API key in the x-api-key header. You can find your API key in your merchant dashboard settings.

Required Header

x-api-key: YOUR_SECRET_API_KEY

API Reference

POSTCreate Invoice

Create a new payment invoice. This endpoint returns a unique invoice ID and a redirect url which you'll use to identify and track the payment.

Base Endpoint
POST /api/invoiceJSON Body
curl -X POST "https://orbituspay.com/api/invoice" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "amount": 100
  }'

GETRetrieve Invoice Details

Fetch full details about an existing invoice, including its payment status and assigned wallet addresses.

/api/invoice/{invoice_id}

POSTMerchant Webhooks

When a payment is confirmed, we send a POST request to your configured callback url with the payment details. We advise checking the amount field to ensure the payment matches your expected amount. We watch for partial payments and notify the user of the remaining balance, but ultimately it is up to you to handle the payment process as OrbitusPay also sends a callback on partial payments.

Callback Payload

{
  "invoice": "820f8623-...", // Invoice Title/ID
  "status": "paid",
  "amount": "100.00",        // Amount in USD
  "hash": "0x123...",        // Transaction Hash
}

Supported Network

Bitcoin

Ethereum

Litecoin

XRP

Integration Flow

1

Initiate Payment

Call POST /api/invoice with the fiat amount you wish to collect.

2

Redirect Customer

Send your user to the Orbitus payment UI at /invoice?title={uuid}.

3

Verification

Our background processors monitor the blockchain. Once payment is detected, the invoice status is updated to paid and your callback URL is triggered with the invoice metadata (title, status, amount, transaction hash, and crypto amount).

Need more help? Join our developer discord.

Explore Example Apps