DOCSEARCHbyAlgolia
Submit Docs

Sevi Documentation

website·Indexed 33 days ago

https://docs.sevi.io

Documentation for Sevi's payment and credit platform, featuring guides for buyers, seller admin portal instructions for managing wallets, payment requests, and transactions, and developer resources for API mutations, queries, and webhook integration.

Tokens
25.5K
Snippets
40
Records
244
Agent score
56%

What's inside Sevi

  1. Overview of Sevi Seller benefits and features

    Sevi is a digital payment and credit platform that allows sellers to offer 'Order Now, Pay Later' to customers while receiving full payment upon delivery. Sevi manages the credit line, buyer verification (KYC), collections, and reminders, removing the risk of late or missed payments for the seller.

    Key seller benefits include:

    • Payment Guarantee: Full payment is received upon confirmation of delivery.
    • Risk Management: Sevi handles KYC, credit rating, and repayments. Customer data is requested directly from the buyer, so sellers do not need to share it.
    • Operational Tools: Access to the Sevi Seller App for monitoring activities, smart dashboards for performance tracking, and automated reconciliation by mapping payments to orders/customers.
    • Integration: Supports integration with ERPs, online shops, and point-of-sale (POS) systems via Mobile and API integrations.

  2. Overview of Sevi Webhooks

    Sevi webhooks send real-time POST requests to a predefined URL when specific events occur, allowing external applications to process payments and customer data without manual intervention. Currently, Sevi supports webhooks for the following events:

    • Orders (created, delivered, item mutation)
    • Customers (added, completed profile)
    • Transactions (all transactions including order details)

  3. Overview of the Sevi Seller Admin Portal

    The Seller Admin Portal is a web-based dashboard designed for Sevi Sellers to manage business activities, monitor performance, and access financial and customer data. It serves as a centralized management tool that complements the mobile app by providing a wider operational view, easier bulk management of orders and customers, and centralized reporting.

  4. Integrate Sevi Partner APIs with business infrastructure

    Sevi Partner APIs allow businesses to incorporate payment methods into various platforms to enhance checkout experiences. Common integration use cases include:

    • ERP Systems: Automating billing/invoicing and enabling real-time financial reporting by logging transactions directly in the ERP.
    • Payment Gateway Interfaces: Connecting existing gateways for streamlined processing and implementing security measures like tokenization.
    • E-commerce Platforms: Adding checkout options to CMS platforms such as WordPress, Joomla, and Shopify.

  5. Repay Order now, Pay later instalments early

    Users can pay any instalment before its due date via the Sevi app. Navigate to the 'Order overview' and click 'Pay' for the specific instalment. The Sevi Account must have a sufficient balance to complete the payment; otherwise, a top-up is required. Users can also enable an automatic sweep option to apply wallet top-ups to open credit before the due date.

  7. Manage payments and sales as a Sevi Seller

    Once activated as a Sevi Seller, you can use the Sevi Seller App to create payment requests for buyers. Sevi pays the seller in full instantly once the buyer confirms the request and delivery. Sevi also manages all repayment collections from buyers on the seller's behalf. Sellers can manage their business, track transactions, and add agents or buyers via the Sevi Seller App or the Admin Portal.

  8. Manage financial activities via the Sevi Seller Admin Transactions page

    The Transactions page in the Seller Admin Portal allows sellers to monitor all financial activities linked to their Sevi account, including payments, withdrawals, and settlements. Users can view a list of completed transactions, search by transaction ID, and filter transactions by specific columns or date ranges to monitor business performance.

  9. Manage and track customer orders in the Seller Admin Portal

    The Orders page provides a centralized view of all customer orders. Sellers can use this interface to track progress, monitor payment and fulfillment statuses, and create new payment requests.

  10. Manage Payments and Credit via PaymentsV3

    The PaymentsV3 system provides a rebuilt payment experience for Buyers, Agents, and Sellers. Key capabilities include installment payments, repay-order flows for paying off credit, and the use of public payment links and public order details (including archived orders).

  11. Order Webhook Payload Reference

    The Sevi Order Webhook sends a JSON payload containing detailed information about the order, shipping details, billing details, and customer information. Key fields include order.status for the delivery state, order.paymentStatus for the payment state, and order.amount for the total cost in the specified order.currency.
    {
  "order": {
    "id": "01234567-abcd-...",
    "referenceNumber": "ORD-123456",
    "platformReference": null,
    "platformId": null,
    "vendorId": "WAL-vendor-...",
    "customerId": "WAL-buyer-...",
    "status": "DELIVERED",
    "paymentStatus": "PAID",
    "paymentMethod": "SEVI_PAY",
    "amount": 5000.00,
    "originalAmount": 5000.00,
    "discount": 0.00,
    "fixedVat": 0.00,
    "percentageVat": 0.00,
    "rewardAmount": 0.00,
    "currency": "KES",
    "name": "Order for Widget",
    "phoneNumber": "+254712345678",
    "notes": null,
    "items": [
      {
        "id": "...",
        "name": "Widget",
        "price": 5000,
        "quantity": 1
      }
    ],
    "ecommercePlatform": "SEVI",
    "creditConfigurationId": "01234567-...",
    "paymentReferenceNumber": "wf-...",
    "returnURL": null,
    "deliverDirect": false,
    "createdByCustomer": false,
    "createdAt": "2025-01-15T09:00:00.000Z",
    "approvedByVendor": "2025-01-15T09:05:00.000Z",
    "shipping": {
      "id": "01234567-abcd-...",
      "firstName": "John",
      "lastName": "Doe",
      "company": null,
      "address1": "123 Main St",
      "address2": null,
      "landmark": "Near the market",
      "city": "Nairobi",
      "state": "Nairobi",
      "postcode": "00100",
      "country": "KE",
      "email": "john@example.com",
      "phoneNumber": "+254712345678",
      "longitude": "36.8219",
      "latitude": "-1.2921",
      "shippingType": null,
      "shippingFee": null,
      "isDefault": true,
      "createdAt": "2024-08-01T00:00:00.000Z"
    },
    "billing": {
      "id": "01234567-abcd-...",
      "firstName": "John",
      "lastName": "Doe",
      "company": null,
      "address1": "123 Main St",
      "address2": null,
      "city": "Nairobi",
      "state": "Nairobi",
      "postcode": "00100",
      "country": "KE",
      "email": "john@example.com",
      "phoneNumber": "+254712345678"
    }
  },
  "customer": {
    "name": "John Doe",
    "email": "john@example.com",
    "reference": "CUS018082",
    "phoneNumbers": ["+254712345678"]
  }
}

  12. Access the Agent Insights performance screen

    To view the performance overview of your Agent account, navigate to the app bar and select the Accounts option. This screen provides a centralized view of account activity and performance metrics.