Reference

API documentation

API documentation

Accept crypto payments over a REST API. Wallets, invoices, rates and webhooks.

Credentials

Every endpoint below is authenticated with an API key and password pair. Creating an account issues yours immediately, with no approval queue and no KYC for sandbox access.

Get API keysSign in

API overview

The Oxialink API lets you accept crypto payments, manage wallets, create invoices, and handle webhooks, all through a simple REST interface.

Base URL
https://oxialink.com/api/v1

Quick start

1

Get your API keys

Find your API key and secret in the credentials section above. Include them as x-api-key and x-api-password headers in every request.

example
curl https://oxialink.com/api/v1 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-password: YOUR_API_SECRET"
2

Create a deposit address

A wallet holds as many addresses as you need, each tracked independently. Give one per customer or per order. With a wallet key the coin comes from the key, so only the label is needed.

example
curl -X POST "https://oxialink.com/api/v1/wallet/address/create" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-password: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"coin": "BTC", "label": "Main Store"}'
3

Create an invoice

Create invoices for customers to pay. You get back a payment address and the invoice is tracked automatically.

example
curl -X POST "https://oxialink.com/api/v1/invoice/create" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-password: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"amount": 99.99, "fiat_currency": "USD", "coin": "BTC"}'
4

Handle webhooks

Set up a webhook endpoint on your server to receive real-time payment notifications. Oxialink sends POST requests when transactions are detected and confirmed.

example
// Wallet IPN: POST to your webhook URL
{
  "coin": "BTC",
  "amount": 0.01000000,
  "status": "confirmed",
  "address": "1A1zP1eP5QGefi2...",
  "txid": "abc123..."
}

// Your server must respond: 200 OK