Developers

API overview

A REST API with JSON requests and responses. The full reference, with Node.js and Python examples, is in the dashboard under API docs.

Create an order

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

  • Four headers on every request: key ID, timestamp, nonce and HMAC-SHA256 signature
  • Requests more than 5 minutes off, or with a reused nonce, are rejected
  • Use your own order number as the Idempotency-Key so retries never create a second order
  • The customer pays at checkout_url and returns to your return_url
POST https://api.routepays.com/v1/orders
X-ACQ-KEY: ak_…
X-ACQ-TS: 1790680394
X-ACQ-NONCE: 9f2c4b1e…
X-ACQ-SIGN: 3b7e…
Idempotency-Key: SO-10086

{
  "amount": "100",
  "external_order_no": "SO-10086",
  "return_url": "https://shop.example.com/orders/SO-10086"
}

201 Created
{
  "order_no": "ACQ2609291213K7QXD2",
  "status": "waiting_payment",
  "checkout_url": "https://checkout.routepays.com/c/c109c905…",
  "expires_at": "2026-09-29T12:43:14Z"
}

Endpoints

EndpointPurpose
POST /v1/ordersCreate an order and get its checkout URL
GET /v1/orders/{order_no}Retrieve an order
GET /v1/ordersList orders, with filters and pagination
POST /v1/orders/{order_no}/cancelCancel an unpaid order
GET /v1/balancesBalances
GET /v1/settlementsSettlements
GET /v1/payoutsWithdrawals
GET /v1/assetsSupported assets and limits
POST /v1/webhooks/testSend a test webhook

Webhooks

Signed

Each delivery carries a timestamp and an HMAC-SHA256 signature over the raw body.

Retried

Failed deliveries are retried with backoff, 7 attempts in total. Event IDs are stable for de-duplication.

Events

order.paid, order.expired, order.held, order.settled, payout.approved, payout.succeeded, payout.failed.

Before going live

  • Create an API key in the dashboard. The secret is shown once; keep it on your server.
  • Set your webhook URL (passkey required) and send a test webhook to check signature verification.
  • Every order is real. Use a small amount for your first end-to-end test.

Get started with RoutePays

Sign up and submit your business details. You can accept payments once approved.