The Order object
The shape of an order wherever the API returns one.
Every endpoint that returns an order returns this shape, wrapped in a data envelope.
Attributes
id
uuid · always presentGyvar's identifier for this order.
status
enum · always presentWhere an order stands. - open - waiting for payment. - paid - paid in full. Fulfil on this. - underpaid - less arrived than asked. Credited to you, and held for you to accept or decline in the dashboard. - closed - you declined the shortfall. The money stays credited to you. - cancelled - cancelled by you or the buyer. - expired - nothing arrived in time. - failed - the payment failed. - refunded - marked refunded. Gyvar moves no money for this. - escalate - under review by our team. One of: open, paid, underpaid, closed, cancelled, expired, failed, refunded, escalate.
kind
enum · always presentcheckout if created through the API, payment_link if started from a payment link. One of: checkout, payment_link, invoice.
reference
string · optional—
description
string · optional—
amount
string · always presentThe total you asked for, in your currency.
amount_minor
string · always present—
currency
string · always present—
currency_decimals
integer · optionalDecimal places of currency. Not always 2: UGX, RWF and XOF have none.
quantity
integer · optional—
unit_amount
string · optional—
unit_amount_minor
string · optional—
settled
object · optionalWhat the buyer sent. Absent until they choose how to pay.
late
boolean · optionalPaid in full after it expired. The money is yours; check stock before shipping.
url
string · optionalThe payment page. Send the buyer here.
success_url
string · optional—
cancel_url
string · optional—
metadata
object · optional—
expires_at
timestamp · always presentWhen the page stops taking payment. Late payments are still credited.
paid_at
timestamp · optional—
created_at
timestamp · always present—
customer_id
uuid · optionalThe customer the order is for: the one you named, or the payer once they have paid.
{
"id": "7b1f9a2c-4e5d-4a8b-9c3f-2d6e1a4b7c90",
"status": "open",
"kind": "checkout",
"reference": "order_1001",
"description": "Order #1001 at Kente & Co",
"amount": "125.50",
"amount_minor": "12550",
"currency": "GHS",
"currency_decimals": 2,
"quantity": "<quantity>",
"unit_amount": "<unit_amount>",
"unit_amount_minor": "<unit_amount_minor>",
"settled": "<settled>",
"late": "<late>",
"url": "https://pay.gyvar.com/chk_live_7b1f9a2c-4e5d-4a8b-9c3f-2d6e1a4b7c90",
"success_url": "<success_url>",
"cancel_url": "<cancel_url>",
"metadata": "<metadata>",
"expires_at": "2026-09-01T10:04:11Z",
"paid_at": "2026-09-01T10:04:11Z",
"created_at": "2026-09-01T10:04:11Z",
"customer_id": "0d6c2f3a-1b4e-4c9a-9f2d-7a1e5c8b3d60"
}