BlockonomicsAPI Reference

Payment Buttons and Checkouts

Embed payment buttons and hosted checkout flows to accept Bitcoin in your website or app.

2 endpoints

Endpoints

Get all orders
GET/merchant_orders
Get order details
GET/merchant_order/{uuid}
object

The order object

An order created via the Blockonomics payment button or checkout flow.

Attributes

codestring

Product code

xpubstring

Extended public key of the wallet

timestampinteger

Unix timestamp of the order

currencystring

Currency used to price the order

namestring

Name of the product

statusinteger

Status of the order

dataobject

Additional customer data

▶Show nested fields
emailidstring

Customer email ID

namestring

Customer name

addressstring

Customer address

phonestring

Customer phone number

Custom Field1string

Custom field 1

Custom Field2string

Custom field 2

emailidstring

Merchant email ID

order_idstring

Unique identifier for the order

addressstring

Bitcoin address for the payment

valueinteger

Order value in fiat currency

descriptionstring

Order description

satoshiinteger

Order value in satoshis

txidstring

Transaction ID if payment is made

paid_satoshiinteger

Amount paid in satoshis

Example object

{
  "code": "",
  "xpub": "",
  "timestamp": 0,
  "currency": "",
  "name": "",
  "status": 0,
  "data": {
    "emailid": "",
    "name": "",
    "address": "",
    "phone": "",
    "Custom Field1": "",
    "Custom Field2": ""
  },
  "emailid": "",
  "order_id": "",
  "address": "",
  "value": 0,
  "description": "",
  "satoshi": 0,
  "txid": "",
  "paid_satoshi": 0
}
GET/merchant_ordersAuth required

Get all orders

Returns all payment button orders for your account.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Query Parameters

limitintegerdefault: 500

The number of records to return

Responses

responsearray[]View order object
limitquery · integer

The number of records to return

Response will appear here

GET/merchant_order/{uuid}Auth required

Get order details

Returns details of a specific payment button order.

Requires Bearer token authentication. Include Authorization: Bearer YOUR_API_KEY in the request header.

Path Parameters

uuidstringrequired

The unique identifier of the order

Responses

Returns a order object
uuidpath · stringrequired

The unique identifier of the order

Response will appear here