Generate Checkout Link

POST /third-parties/checkout-link/generate-checkout-url

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description	Required
orderReference	string	Your Order Reference, shouldn't include special characters such as !@#$%^&*()_+-=[]{};':"\|,.<>/?~]	true
orderCurrency	"TZS" | "USD"	Order Currency	true
totalPrice	number	Total Price	true if no added order items
orderItems	array of objects	An array of items, where each item includes name, price, and quantity fields.	true if total price is not added
customerName	string	Customer full name	false
customerEmail	string	Customer email	false
customerPhone	string	Customer phone number	false

Object structure of orderItems

Field	Dype	Description
name	string	The name of the item.
price	number	The price of the item.
quantity	number	The quantity of the item ordered.

Response

200

{
  checkoutLink: "https://checkout.clickpesa.com/{reference}"
}

400

// when api keys used are from application that doesn't have HOSTED Checkout feature turned On
{
    message: "Invalid credentials"
}

// when merchant didn't turn on checkout link in the merchant dashboard
{
    message: "Merchant shop does not exists"
}

// when orderReference has special characters
{
    message: "Invalid Order Reference, should only contain alphanumeric characters and cannot be blank"
}

// when currency is neither TZS nor USD
{
    message: "Invalid currency: {value}"
}

// when order items are added but doesnt have a name, price or quantity
// name
{
    message: "All items must have a name"
}
//price
{
    message: "All items must have a price"
}
// quantity
{
    message: "All items must have a quantity"
}

// when no order item and total price added
{
    message: "Total Price is required"
}

409

// When order reference already exist in a payment record
{
    message: "Unique order reference is required"
}

401

{
    message: "Unauthorized"
}