Order

Retrieve an order by ID

get

https://api.ordinalsbot.com/tokenpayhttps://signet-api.ordinalsbot.com/tokenpayhttps://testnet-api.ordinalsbot.com/tokenpay

/order/{orderId}

Fetches an order from the Firestore database using the provided order ID.

Path parameters

orderIdstringRequired

The ID of the order to retrieve.

Example: 1234567890abcdef

Responses

200

Successfully retrieved the order.

application/json

createdAtintegerOptionalExample: 1721745751531

accountIdstringOptionalExample: ordinalsbot

descriptionstringOptionalExample: e14fefbe-fc23-40a2-b0d6-6aab7bff3438

idstringOptionalExample: f2bcddd4-bd8d-4c88-bf8a-61be0d5b0600

statestringOptionalExample: pending

webhookUrlstringOptionalExample: https://webhook.site/f5a2dcec-b7e4-4845-92d1-22ded0057104

404

Order not found.

application/json

get

/order/{orderId}

HTTPcURLJavaScriptPython

GET /tokenpay/order/{orderId} HTTP/1.1
Host: api.ordinalsbot.com
Accept: */*

{
  "createdAt": 1721745751531,
  "accountId": "ordinalsbot",
  "feeCharge": {
    "createdAt": 1721745751432,
    "additionalFee": 23315,
    "amount": 32315,
    "protocol": "bitcoin",
    "address": "bc1qh3rp2pns6nrr8mhx0rlzd5kktwm33wc4ax0h4y",
    "txid": null,
    "state": "pending_payment",
    "token": "BTC"
  },
  "description": "e14fefbe-fc23-40a2-b0d6-6aab7bff3438",
  "id": "f2bcddd4-bd8d-4c88-bf8a-61be0d5b0600",
  "state": "pending",
  "tokenCharge": {
    "createdAt": 1721745751530,
    "additionalFee": 0,
    "amount": 1,
    "protocol": "rune",
    "address": "bc1p76ppg0q24p2v6faxkaffrvtg0n9u2wvgjzr2g48nfnhk6z7g8wasnwtsql",
    "txid": null,
    "state": "pending_payment",
    "token": "SHITCOINPARADISE"
  },
  "webhookUrl": "https://webhook.site/f5a2dcec-b7e4-4845-92d1-22ded0057104"
}