Rune
Creates a new Rune order with the specified details. If webhookUrl
is provided, a webhookSecretToken
will be sent in the response. webhookSecretToken
is a shared secret between the server and the user. It is the only way to authenticate the incoming webhooks. It is unique for every order. webhookSecretToken
should be saved by the user in the database and checked on every received webhook.
Header parameters
x-api-keystringRequiredExample:
API key for authentication.
your-api-key
Body
amountnumberOptionalExample:
The amount for the order.
1
tokenstringOptionalExample:
The token for the order.
SHITCOINPARADISE
webhookUrlstringOptionalExample:
The webhook URL for the order.
https://webhook.site/f5a2dcec-b7e4-4845-92d1-22ded0057104
additionalFeeintegerOptionalExample:
The additional fee for the order.
0
descriptionstringOptionalExample:
The description for the order.
e14fefbe-fc23-40a2-b0d6-6aab7bff3438
Responses
200
Successfully created the order.
application/json
400
Bad request. Invalid input parameters.
application/json
500
Internal server error.
application/json
post
POST /tokenpay/user/order/rune HTTP/1.1
Host: api.ordinalsbot.com
x-api-key: your-api-key
Content-Type: application/json
Accept: */*
Content-Length: 183
{
"amount": 1,
"token": "SHITCOINPARADISE",
"webhookUrl": "https://webhook.site/f5a2dcec-b7e4-4845-92d1-22ded0057104",
"additionalFee": 0,
"description": "e14fefbe-fc23-40a2-b0d6-6aab7bff3438"
}
{
"id": "b15ad7f6-b34a-4a1e-8c0f-30492610a3d6",
"createdAt": 1730120609939,
"accountId": "ordinalsbot",
"feeCharge": {
"amount": 100,
"token": "BTC",
"address": "bc1qd0a0kq9hdmem24x229s7pytgp759et7takws72",
"state": "pending_payment",
"protocol": "bitcoin",
"txid": null,
"createdAt": 1730120609719,
"additionalFee": 100
},
"tokenCharge": {
"amount": 1,
"token": "SHITCOIN•PARADISE",
"address": "bc1prhdced0h23ppfvqqk2pe5k092u5ncev8rmvvlz6h5kvezcd2g93qfjmg9v",
"state": "pending_payment",
"protocol": "rune",
"txid": null,
"createdAt": 1730120609939,
"additionalFee": 0
},
"webhookUrl": "https://api.ordinalsbot.com/webhook/tokenpay",
"successUrl": null,
"state": "pending",
"description": "56f3f01e-407b-4099-b172-591501f7129d",
"webhookSecretToken": "c051a42521ab8d2987c3626a6246d99f8a3397cd6be626ee0eeb7f5457e92432"
}