DEVELOPERS

API Reference

An illustrative look at the LYRIA API surface. Endpoints below represent the shape of the API and are not a live or final contract.

POST/v1/payments

Create a new payment. LYRIA routes the transaction to the best-performing acquirer or provider for the corridor.

Request

{
  "amount": 4200,
  "currency": "CAD",
  "merchant_id": "mrc_8f2a1c",
  "payment_method": "card"
}

Response

{
  "id": "pay_9k3lm2",
  "status": "authorized",
  "routed_via": "acquirer_a",
  "amount": 4200,
  "currency": "CAD"
}

GET/v1/transactions/:id

Retrieve the full lifecycle of a transaction, including routing decisions and settlement status.

Request

GET /v1/transactions/pay_9k3lm2

Response

{
  "id": "pay_9k3lm2",
  "status": "settled",
  "routing_history": [
    { "provider": "acquirer_a", "result": "approved" }
  ],
  "settled_at": "2026-07-04T18:32:00Z"
}

POST/v1/payouts

Initiate a payout to a merchant or partner across a supported settlement rail.

Request

{
  "amount": 100000,
  "currency": "USD",
  "destination": "acct_4b7d9e",
  "rail": "wire"
}

Response

{
  "id": "out_2p9qz1",
  "status": "processing",
  "estimated_settlement": "2026-07-07T00:00:00Z"
}

Talk to us about API access.

Request Access