Checkout Page

{
  "mode": "ONE_TIME", // RECURRING or SAVE
  "amount": "1200.00"
  // or create a new order
  "order": {
    "description": "Monthly plan + setup"
  }
}

{
  "mode": "SAVE"
  // if no customer object or customer_id passed then a form will show on the payment link to create a customer. Add the customer_fields parameter to specify what fields should be captured.
}

{
  "mode": "ONE_TIME", // RECURRING or SAVE
  "amount": "1200.00",
  "currency": "ZA",
  // [options for order records]
  // [option 1: use the order_id of an existing order record]
  "order_id": "ord_12345",
  // [option 2: use the order.description field to create an order, if no order.reference passed then one will be created]
  "order": {
    "reference": "ORD0045",
    "description": "Monthly plan + setup",
    "amount_subtotal": "1100.00",
    "amount_discount": "0.00",
    "amount_shipping": "0.00",
    "amount_tax": "100.00",
    "amount_total": "1200.00",
    "items": [
      {
        "sku": "SKU00567",
        "name": "Pro Plan (Monthly)",
        "quantity": 1,
        "unit_amount": "1200.00",
        "tax_amount": 0,
        "discount_amount": 0,
        "currency": "ZA",
        "metadata": {
          "custom_field_1": "custom data 1",
          "custom_field_2": "custom data 2"
        }
      }
    ]
  },
  // [options for customer records]
  // [option 1: use the customer_id of an existing customer record]
  "customer_id": "cus_abc123...",
   // [option 2: if no customer id or customer object is passed then a form will show, here you can specify the fields to capture, name and surname will always show]
  "customer_fields": "reference,id_number,email,contact_number,billing,shipping",
  // [option 3: create a new customer]
  "customer": {
    "reference": "CLN240919000001",
    "company_name": null,
    "person_name": "John",
    "person_surname": "Doe",
    "client_type": "RESIDENT_INDIVIDUAL", // [optional]
    "id_type": "SAID",
    "id_number": "900112....",
    "email": "johndoe@mail.com",
    "contact_number": "+27831234567",
    "billing_address": {
        "line1": "1 Loop Street",
        "line2": "Floor 5",
        "city_or_town": "Cape Town",
        "province_or_state": "Western Cape",
        "postal_or_zip_code": "8001",
        "country": "ZA"
    },
    "shipping": {
      "contact_name": "Jane Doe",
      "contact_number": "+27820000000",
      "address": {
        "line1": "1 Loop Street",
        "line2": "Floor 5",
        "city_or_town": "Cape Town",
        "province_or_state": "Western Cape",
        "postal_or_zip_code": "8001",
        "country": "ZA"
      },
    },
    "metadata": {
      "custom_field_1": "custom data 1",
      "custom_field_2": "custom data 2"
    },
  },
  "redirects": {
    "success_url": "https://merchant.example/success?order=ord_12345",
    "cancel_url": "https://merchant.example/cancel?order=ord_12345",
    "notify_url": "https://merchant.example/webhooks/payments"
  },
  "payment": {
    "payment_methods": ["CARD", "ZAPPER"], // [optional: populate to specify payment methods to show else all will show]
    "payment_type": "DB" // [optional: Direct Debit (DB) or Pre-Authorization PA, defaults to DB
  },
  "cards": {
    "save_cards": true, // [optional: save cards for recurring or on click checkouts]
    "show_cards": true // [optional: show previous saved cards for use to select from]
  },
  "notifications": {
    "send_invoice": true,
    "send_confirmation_email": true,
    "confirmation_email_override": "accounts@example.com"
  },
  "customization": {
    "locale": "EN_ZA",
    "theme": "LIGHT",
    "type": "PAGE", // or EMBED
    "display_cancel_button": true,
    "display_total": true,
    "display_cart": true,
    "brand": {
      "primary": "#00DC82",
    }
  }
}

{
    "status": true,
    "result": {
      "id": "chk_abc123...",
      "session_id": "ses_abc123...",
      "amount": "1200.00",
      "currency": "ZA",
      "order_id": "ord_12345",
      "customer_id": "cus_abc123...",
      "page_url": "https://pay.kwik.co.za/checkout/cs_test_a1b2c3",
      "expires_at": "2025-09-13T12:30:00Z"
    }
}

{
  "event": "checkout.completed", // checkout.expired, checkout.failed
  "data": [{
    "checkout": {
      "id": "chk_abc123...",
      "session_id": "ses_abc123...",
      "amount": "1200.00",
      "currency": "ZA",
      "order_id": "ord_12345",
      "customer_id": "cus_abc123...",
      "card_id": "crd_abc123...", // return a card id if a card payment was made
      "transaction_id": "tra_abc123...",
      "transaction_status": "RUNNING",
      "expires_at": "2025-09-13T12:30:00Z",
      "completed_at": "2025-09-13T10:15:30Z"
    },
    // return a payment only if a recurring payment was created
    "payment": {
      "id": "pay_abc123...",
      "amount": "1200.00",
      "currency": "ZA",
      "payment_status": "COMPLETED",
      "payment_method": "CARD",
      "payment_method_id": "pam_abc123...",
      "created_at": "2025-09-13T10:15:30Z"
    }
  }],
  "created_at": "2025-09-13T10:15:30Z"
}