API reference

Easy Digital Downloads

The Orboni for Easy Digital Downloads plugin adds “Crypto” to your checkout, with no code. The buyer presses Purchase, picks a coin on Orboni’s payment page and pays from any wallet or exchange. The money goes to the wallets you set in the dashboard, and once the payment is final on the chain the order is completed by itself: the receipt is emailed and the files unlock.

It needs WordPress 6.5, Easy Digital Downloads 3.1 and PHP 7.4 or later.

Set it up

  1. 1In WordPress, go to Plugins → Add New Plugin, search for “Orboni” and install Orboni for Easy Digital Downloads, then activate it. Easy Digital Downloads must be active.
  2. 2In the Orboni dashboard, set the wallets you want to be paid to under Wallets, then copy a secret key under Developers → API keys — a test key (sk_test_…) first.
  3. 3In WordPress, open Downloads → Settings → Payments → Orboni and paste the key. Then tick “Orboni (crypto)” under Downloads → Settings → Payments → General → Active Gateways.
  4. 4Under Developers → Webhooks, add an endpoint at https://your-store.com/wp-json/orboni-edd/v1/webhook (the plugin’s settings show your store’s own address) with every event, or at least the checkout.session.* ones, and paste its signing secret (whsec_…) into the plugin’s settings.
  5. 5Place an order, and on its payment page, signed in to the dashboard, press Simulate payment: the order turns Completed. Then swap in your live key and the live endpoint’s secret.

How orders move

The plugin reads the payment back from Orboni before it changes an order, and the order follows the payment as it is now — whether the webhook, the buyer’s return or a scheduled check comes first, twice or out of order.

PaymentOrboni saysThe order
Paid in fullcomplete, paidCompleted: the receipt is emailed and the files unlock
On the chain, not final yetprocessingProcessing, until it is final
Part paidpartially_paidOn Hold, with how much came; the payment page asks the buyer for the rest
Held for your reviewheldOn Hold, with the reason; accept it in the dashboard and the order is completed
Ran out with nothing paidexpired, unpaidAbandoned, if it still waits for payment
Ran out part paidexpired, partially_paidOn Hold, with what arrived: settle it with the buyer
Money that paid it left the chainpayment_reversedBack to On Hold, its files locked until the dashboard shows it paid again
More came after it was paidextra_receivedA note with the total; the order stays completed

A completed order is never taken back by anything else. Each change is written on the order as a note: the coin, the network, the amount and the session. Without a webhook the order still moves: the plugin reads the payment when the buyer comes back from the payment page, ten minutes after the page opens, and again after it runs out. A buyer who comes back before the payment is final sees, above the receipt, whether it is on its way, being checked or not seen yet.

Good to know

  • Your store’s currency: US dollars, euros, pounds, yen or any other currency a checkout session takes (Currencies in the API reference). The payment page shows the order’s total in it, and Orboni turns it into dollars at the rate of the day (the European Central Bank’s, or the market’s for a currency the ECB does not publish); the buyer pays that in the coin they pick. In a store whose currency is not on the list Crypto is not offered at checkout, and the settings page says so.
  • The least is worth $1.00. In a US-dollar store the plugin does not offer Crypto for a smaller order; in another currency Orboni checks the total’s worth when the buyer presses Purchase, and a buyer whose order is worth less is told it is below the minimum for a crypto payment.
  • A buyer who goes back and presses Purchase again gets the same payment page while it has more than five minutes left, never a second session for the same order and amount. An order left unpaid is taken up again by Easy Digital Downloads’ own recovery.
  • An order whose cart grew after the buyer was sent to pay is put On Hold when the payment completes, not completed.
  • Refunds: the money is in your wallet, so send it back from there and record the refund in the dashboard. The plugin does not refund through Easy Digital Downloads.
  • Several stores can share one Orboni project: each adds its own endpoint and acts only on its own orders. A site that runs Orboni for WooCommerce too keeps the two apart.
  • Turn on “Debug log” in the settings to see every request under Downloads → Tools → Debug Log, in lines starting with “Orboni:”. Errors are logged either way; keys and signing secrets never are.

What the plugin sends

Each order makes a checkout session through POST /v1/checkout/sessions, with an idempotency key of the store, the order, the amount and its currency, and the try, so a retry never makes a second one.

amountinteger
The order’s total, in the currency’s smallest unit: cents, or whole yen.
currencystring
The store’s currency, in lower case: usd, eur, jpy…
descriptionstring
The items, as “E-book × 2, Course — Pro”, cut at 250 characters.
detailsstring
The order’s number and your store’s name: “Order 1042 at Pixel Fonts”.
client_reference_idstring
The Easy Digital Downloads order’s id.
metadataobject
edd_order_id, edd_order_number, and edd_site — a short hash of the store’s address, so two stores on one project never act on each other’s events.
customer_emailstring
The buyer’s email, where Orboni sends the receipt when your project sends receipts.
localestring
The language WordPress is showing the buyer.
success_url, cancel_urlstring
The store’s confirmation page, which reads the payment and goes on to the receipt; and the checkout, its cart still full.

A completed order keeps the session’s id as its transaction id, so a payment in the dashboard, an export or a webhook leads to its order by client_reference_id, and the order to its payment by the transaction id.

This page as Markdown, for a program or an AI assistant: /docs/easy-digital-downloads.md. Something missing or unclear? Write to us from the dashboard’s Help & Support.