API reference

Invoices

Request an invoice for products, subscriptions, services, or ticket tiers.

POST /Payment/requestInvoice creates an invoice for a customer and returns the details your integration needs to continue the payment flow.

This endpoint does not use a Bearer token. The business is identified by the business_id in the request body.

Request body

Field	Type	Required	Description
`phone`	string	Yes	The paying customer's phone number.
`business_id`	string	Yes	The Xara business receiving the payment.
`items`	string	Yes	JSON string of `[{ product_id, quantity }]`. Each product must belong to the business.
`customer_name`	string	No	Customer name. Derived from the phone number when omitted.
`note`	string	No	Free-text note stored on the invoice.
`delivery_destination_id`	ID	No	A delivery destination belonging to the business. Its fee is added as a line item.

Each entry inside items contains the catalog item's product_id and its quantity. Xara calculates pricing from the business catalog.

items is a JSON-encoded string, not a nested JSON array. In JavaScript, build the array normally and pass it through JSON.stringify(items) before sending the request.

The success response contains invoice information in data. Keep the returned invoice reference with your own order or checkout ID. The same reference appears in payment webhooks, so use it to match the payment to your order.

Do not mark an order as paid only because invoice creation succeeded. Wait for an invoice.paid webhook, verify its signature, and make sure you do not process the same delivery twice.

The request panel is read-only. It shows the request and response format but does not send anything to the API.

Tickets

Create ticketed events and retrieve the tiers available for sale.

Markdown Syntax

Text, title, and styling in standard markdown.

Invoices

POST/Payment/requestInvoice

Create an invoice and store its reference so you can match the payment.

curl --request POST \
  --url https://graph.usexara.ai/rest/Payment/requestInvoice \
  --header "Content-Type: application/json" \
  --data '{
    "phone": "2348012345678",
    "business_id": "42",
    "customer_name": "Ada Lovelace",
    "items": "[{\"product_id\":128,\"quantity\":1}]",
    "note": "Order #ORD-1042"
  }'

Example only · requests are not sent from this documentation

Invoices

Request body

Handle the response