Basket

This endpoint allows clients to submit a basket for processing. The basket will be associated with a transaction that will be processed by the Sentinal system.

Submit Basket

POST /v1/basket/submitBasket

This endpoint allows clients to submit a basket for processing. The basket will be associated with a transaction that will be processed by the Sentinal system.

Headers

Name
Type
Description

x-api-key*

string

Request Body

Name
Type
Description

ref*

string

External reference

totalAmount*

number

items*

array

{"sku": "ITEM001", "title": "Sample item 1", "description": "This is a sample item", "quantity": 2, "vatExempt": false (optional), "price": 45.25, "subTotal": 90.50}

paymentMethods*

object

currency*

string

countryCode*

string

{
    "success": true,
    "message": "Basket submitted successfully.",
    "content": {
        "basketId": "7qC5lkq0wXDbEoGVzb0t",
        "vatAmount": 7.5375,
        "originalBasketData": {
            "ref": "BASKET12345",
            "totalAmount": 100.5,
            "items": [
                {
                    "sku": "ITEM001",
                    "title": "Sample Item 1",
                    "description": "This is a sample item.",
                    "quantity": 2,
                    "price": 45.25,
                    "vatExempt": false,
                    "subtotal": 90.5
                },
                {
                    "sku": "ITEM002",
                    "title": "Sample Item 2",
                    "description": "This is another sample item.",
                    "quantity": 1,
                    "price": 10,
                    "subtotal": 10
                }
            ],
            "paymentMethods": {
                "card": 80.5,
                "vouchers": 10,
                "discounts": 5,
                "cash": 5
            },
            "currency": "NGN",
            "countryCode": "NG"
        },
        "status": "PENDING",
        "transactionId": "61p2pKSC1n9pKgKpwz6l"
    }
}

Last updated