The One QR object

OneQR codes are an efficient and cost-effective way of receiving Bitcoin payments in person. No point-of-sale or mobile app is needed! Simply generate a static QR code through the Speed web application, download it, and print it to start accepting payments.

There are two methods available for this: lnurl or onchain. To generate a QR, select your preferred method and give a name to the QR. Additionally, you can set up a success message for your customers to be displayed once they make the payment in their wallet.

Response

{
  "id": "oqr_xxxxxxxxxxxxxxxxxxxxxxx",
  "object": "oneqr",
  "status": "active",
  "oneqr_method": "lnurl",
  "currency": "USD",
  "payment_request": "lnurlxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "name": null,
  "description": null,
  "statement_descriptor": null,
  "success_message": null,
  "success_url": null,
  "wallets_of_country": "US",
  "created": 1676277740874,
  "modified": 1676277740874
}

Attributes


id string
Unique identifier for the object.


object string
The type of the object indicates to which entity this response belongs.


status string
One QR can have 2 statuses, as mentioned below:

    active
    One QR is active after its generation until it is deactivated.
    deactivated
    You can manually deactivate a One QR if you no longer wish to get paid via it.


oneqr_method string
Both onchain and lnurl methods can be used to receive funds. This indicates which method (lnurl or onchain) will be used to receive funds through QR.


currency string
The base currency in which you prefer to work.


payment_request string
The payload for generating a QR code is returned. It specifies the BTC wallet address to which the payment is processed for the onchain method and lnurl in the case of the lnurl method.


name string
This parameter specifies the name of this QR code for you to easily manage multiple QRs under the same business account.


description string
Additional information about this QR.


statement_descriptor string
Additional information about a payment made to an account using this QR.


success_message string
Message customers will see when they make payment via their preferred wallet.


success_url string
Customers will see this clickable link in their wallet if the transaction goes through successfully.


wallets_of_country string
This specifies the country where the QR code will be used. Based on the country, the QR code image suggests wallets customers can use to make payments. Note they can use any other supported wallets too.


created timestamp
Time at which the One QR object was created.


modified timestamp
Time at which the last modification was made.