Gyvar docs
API reference v1Checkout

Cancel an order

Cancels an `open` order and frees its `reference`. Money that still arrives is credited to you and shown in the dashboard. Needs the `receive` capability.

POST
/checkout/orders/{id}/cancel

Authorization

KeyID Timestamp Nonce Signature
X-Gyvar-Key<token>

Your key id, gyv_k_live_... or gyv_k_sandbox_....

In: header

X-Gyvar-Timestamp<token>

Unix seconds. Must be within 5 minutes of our clock.

In: header

X-Gyvar-Nonce<token>

A unique value per request. Replays are rejected.

In: header

X-Gyvar-Signature<token>

Ed25519 signature over the canonical string. See the Signing guide.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/checkout/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{  "data": {    "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": 0,    "unit_amount": "string",    "unit_amount_minor": "string",    "settled": {      "asset": "USDT",      "chain": "tron",      "network": "onchain",      "quoted": "8.120000",      "quoted_minor": "8120000",      "received": "8.120000",      "received_minor": "8120000",      "short_by": "string",      "short_by_minor": "string",      "over_by": "string",      "over_by_minor": "string"    },    "late": true,    "url": "https://pay.gyvar.com/chk_live_7b1f9a2c-4e5d-4a8b-9c3f-2d6e1a4b7c90",    "success_url": "http://example.com",    "cancel_url": "http://example.com",    "metadata": {},    "expires_at": "2019-08-24T14:15:22Z",    "paid_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e"  }}

The Order object

The shape of an order wherever the API returns one.

Create an order

Creates an order and returns the `url` to send the buyer to. Returns 201 for a new order, and 200 if this `reference` already has one open. Send `amount`, `amount_minor`, or both. If both, they must agree at the currency's decimal places, or the order is refused with `amount_mismatch`. `success_url` and `cancel_url` are optional, and must be on an origin registered under Settings, Payment links. Needs the `receive` capability.