Checkout and refunds

​

Create an itemised checkout

{
  "email": "[email protected]",
  "amount": 125000,
  "currency": "NGN",
  "partner_reference": "SL-BOOKING-77",
  "line_items": [
    { "name": "Night (Lekki 2-bed)", "quantity": 2, "unit_amount": 55000, "partner_line_reference": "night" },
    { "name": "Cleaning", "quantity": 1, "unit_amount": 15000, "partner_line_reference": "cleaning" }
  ],
  "success_url": "https://book.example.com/paid",
  "cancel_url": "https://book.example.com/cancelled",
  "fee_bearer": "customer"
}

• The sum of quantity × unit_amount must equal amount exactly, to the kobo.
• quantity must be between 1 and 10,000.
• Amounts have at most 2 decimals.
• Each line needs a non-empty partner_line_reference that is unique within the checkout.
• There can be at most 100 lines.

​

Read a checkout

• GET /v1/checkout/{checkout_id}: public. Includes partner_reference, line_items and status.
• GET /v1/partner/checkouts/{partner_reference}: needs your API key. object_ref is the checkout id; status is created or paid.

​

Refund by line

{
  "reason": "Guest cancelled night 2",
  "idempotency_key": "SL-RF-9",
  "partner_reference": "SL-REFUND-9",
  "lines": [ { "partner_line_reference": "night", "amount": 55000 } ]
}

• The amount is the sum of lines. amount is optional; if you send it, it must agree with that sum.
• Partner refunds must state amount or lines, and they count against your refund limits.
• A line can never be refunded beyond what it was paid, less earlier refunds that did not fail. The check runs under a lock, so two refunds sent at the same moment cannot overspend a line.