Paymenter
The Orboni gateway lets your clients pay Paymenter invoices in crypto, with no code. The client presses Pay on an invoice, 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 the invoice is marked paid by itself once the payment is final on the chain. Paymenter then activates or renews what the invoice was for, as after any payment.
It needs Paymenter 1.4 or later and is tested on 1.5.9. It has no cron of its own: Orboni’s webhook and the client’s return record each payment. It is free, and its source is open, under the MIT license: orboni/paymenter-gateway on GitHub.
Set it up
- 1Download
orboni-paymenter-…zipfrom the newest release and put theOrbonifolder in it atextensions/Gateways/Orboniof your Paymenter. The folder must be namedOrboni. - 2In Paymenter’s admin, go to Extensions → Gateways, add a gateway and choose Orboni.
- 3In 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 — into the gateway’s Secret key. - 4Under Developers → Webhooks, add an endpoint at
https://your-paymenter-site.com/extensions/gateways/orboni/webhook(the gateway’s settings show your own), with every event, or at least thecheckout.session.*ones. Paste its signing secret (whsec_…) into Webhook signing secret and save. - 5Pay an invoice with Orboni, and on its payment page, signed in to the dashboard, press Simulate payment: the invoice turns paid. Then swap in your live key and the live endpoint’s secret. The key decides test or live.
How an invoice moves
The gateway reads the payment back from Orboni before it changes an invoice, so the webhook and the client’s return can come in any order, or twice, with the same result. Each payment is one transaction on the invoice, whose id is the session’s.
| Payment | Orboni says | In Paymenter |
|---|---|---|
| Paid in full | complete, paid | The transaction succeeds and the invoice is paid |
| On the chain, not final yet | processing | A processing transaction; the invoice page waits |
| Part paid | partially_paid | A processing transaction; the payment page asks the client for the rest |
| Held for your review | held | A processing transaction; accept the payment in the dashboard and the invoice is paid |
| Ran out with nothing paid | expired, unpaid | A processing transaction, if one was made, fails; the invoice stays unpaid |
| Ran out part paid | expired, partially_paid | The transaction stays processing and the invoice unpaid; the log says what arrived: settle it with the client |
| Money that paid it left the chain | payment_reversed | The transaction goes back to processing until Orboni shows it paid again |
| More came after it was paid | extra_received | The log says what came in all; send the extra back from your wallet if the client asks |
Without a webhook a payment is still recorded once the client comes back from the payment page, as it is at that moment; one confirmed later is recorded only by the webhook, so set it up. Every change goes to Paymenter’s log, starting with “Orboni:”.
Good to know
- The invoice’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 total in it, and the client pays its worth in the coin they pick. In any other currency the gateway is not offered.
- The least is worth $1.00. The gateway is not offered for a smaller invoice.
- A client who presses Pay again while the payment page has more than five minutes left goes back to the same page, never to a second one for the same amount.
- An invoice already paid when an Orboni payment completes keeps both payments, and the log says so: send the second back from your wallet or keep it as credit.
- One-time payments only. Each renewal invoice is paid like any other.
- Refunds: the money is in your wallet, so send it back from there and record the refund in the dashboard.
- Several Paymenter sites can share one Orboni project: each adds its own endpoint and acts only on its own invoices.
- Keys and signing secrets are stored encrypted by Paymenter and never logged.
What the gateway sends
Each payment makes a checkout session through POST /v1/checkout/sessions, with an idempotency key of the site, the invoice, the amount and the try, so a retry never makes a second one.
- amountinteger
- What is left on the invoice, in the currency’s smallest unit: cents, or whole yen.
- currencystring
- The invoice’s currency, in lower case: usd, eur, jpy…
- descriptionstring
- The invoice’s lines, as “Web hosting Starter, Domain example.com × 2”, cut at 250 characters.
- detailsstring
- The invoice’s number and your site’s name: “Invoice 1042 at Example Hosting”.
- client_reference_idstring
- The invoice’s id in Paymenter.
- metadataobject
- paymenter_invoice_id, paymenter_invoice_number, and paymenter_site — a short hash of the site’s address, so two sites on one project never act on each other’s events.
- customer_emailstring
- The client’s email, where Orboni sends the receipt when your project sends receipts.
- localestring
- The language Paymenter shows the client.
- success_url, cancel_urlstring
- The gateway’s return address, which reads the payment back and sends the client on to the invoice; and the invoice’s page.
The transaction keeps the session’s id, so a payment in the dashboard, an export or a webhook leads to its invoice by client_reference_id, and an invoice to its payment by the transaction id.
This page as Markdown, for a program or an AI assistant: /docs/paymenter.md. Something missing or unclear? Write to us from the dashboard’s Help & Support.