Orders

List of endpoints to place, fetch, update and cancel order.

The Order Object

Attributes

Attribute	Data type	Required	Description
actTotalFee	`string`	true	Unique identifier for the customer
outOrderNo	`integer`	true	Unique identifier for the customer's order
productList	`array`	true	The cart items
storeId	`string`	true	the store id obtained from lipalater team

Product List Attributes

Attribute	Data type	Required	Description
actTotalFee	`integer`	true	Total paid price of goods
brand	`string`	true	The item brand
price	`integer`	true	product price
productLogo	`string`	true	Product logo
productName	`string`	true	Product name
productNo	`string`	true	Product id
productNum	`integer`	true	product quantity
saleprice	`integer`	true	Total sales price of goods
skuDesc	`string`	true	The product description

API request

POST {BASE_URL}/open/op/order/{memberId}/create

curl -i -X POST '{BASE_URL}/open/op/order/{memberId}/create' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>' \
  -d '{
  "actTotalFee": 0,
  "outOrderNo": "",
  "productList": [
    {
      "actTotalFee": 0,
      "brand": "",
      "price": 0,
      "productLogo": "",
      "productName": "",
      "productNo": "",
      "productNum": 0,
      "salePrice": 0,
      "skuDesc": ""
    }
  ],
  "storeId": ""
}'

Request object

{
  "actTotalFee": 0,
  "outOrderNo": "",
  "productList": [
    {
      "actTotalFee": 0,
      "brand": "",
      "price": 0,
      "productLogo": "",
      "productName": "",
      "productNo": "",
      "productNum": 0,
      "salePrice": 0,
      "skuDesc": ""
    }
  ],
  "storeId": ""
}

JSON response

{
 "code": 0,
 "data": {
  "actTotalFee": 0,
  "createTime": "",
  "memberId": "",
  "orderNo": "",
  "orderProductList": [
   {
    "actTotalFee": 0,
    "brand": "",
    "createTime": "",
    "memberId": "",
    "orderNo": "",
    "productLogo": "",
    "productName": "",
    "productNo": "",
    "productNum": 0,
    "salePrice": 0,
    "skuDesc": "",
    "storeId": "",
    "totalFee": 0,
    "updateTime": ""
   }
  ],
  "outOrderNo": "",
  "storeId": "",
  "totalFee": 0,
  "updateTime": ""
 },
 "msg": "",
 "success": true
}

Get Order Details

params

Attribute	Data type	Required	Description
orderNo	`string`	true	The order number

request

GET {BASE_URL}/open/op/order/{memberId}/detail/{orderNo}

curl -i -X GET '{BASE_URL}/open/op/order/{memberId}/detail/{orderNo}' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>'

Response

{
 "code": 0,
 "data": {
  "actTotalFee": 0,
  "closeReason": "",
  "closeTime": "",
  "createTime": "",
  "creditFee": 0,
  "creditPayNo": "",
  "creditPayStatusEnum": "",
  "creditPayTime": "",
  "depositFee": 0,
  "installPlanId": 0,
  "memberId": "",
  "orderNo": "",
  "orderProductList": [
   {
    "actTotalFee": 0,
    "brand": "",
    "createTime": "",
    "memberId": "",
    "orderNo": "",
    "productLogo": "",
    "productName": "",
    "productNo": "",
    "productNum": 0,
    "salePrice": 0,
    "skuDesc": "",
    "storeId": "",
    "totalFee": 0,
    "updateTime": ""
   }
  ],
  "orderStatusEnum": "",
  "outOrderNo": "",
  "payStatusEnum": "",
  "payTime": "",
  "prePayNo": "",
  "prePayTime": "",
  "prepayFee": 0,
  "storeId": "",
  "totalFee": 0,
  "upFrontFee": 0,
  "updateTime": ""
 },
 "msg": "",
 "success": true
}

Get Repayment Schedule

params

Attribute	Data type	Required	Description
countryId	`integer`	true	the country id options `ke=10001`
orderNo	`string`	true	The order number
loanProductId	`integer`	true	product id

request

GET {BASE_URL}/open/op/order/calculateSchedule/

curl -i -X GET '{BASE_URL}/open/op/order/calculateSchedule/' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>'

Response

{
 "code": 0,
 "data": {
  "currency": "",
  "deposit": 0,
  "installment": 0,
  "periods": [
   {
    "complete": true,
    "daysInPeriod": 0,
    "dueDate": "",
    "feeChargesDue": 0,
    "feeChargesOutstanding": 0,
    "feeChargesPaid": 0,
    "feeChargesWaived": 0,
    "feeChargesWrittenOff": 0,
    "fromDate": "",
    "interestDue": 0,
    "interestOriginalDue": 0,
    "interestOutstanding": 0,
    "interestPaid": 0,
    "interestWaived": 0,
    "interestWrittenOff": 0,
    "penaltyChargesDue": 0,
    "penaltyChargesOutstanding": 0,
    "penaltyChargesPaid": 0,
    "penaltyChargesWaived": 0,
    "penaltyChargesWrittenOff": 0,
    "period": 0,
    "principalDue": 0,
    "principalLoanBalanceOutstanding": 0,
    "principalOriginalDue": 0,
    "principalOutstanding": 0,
    "principalPaid": 0,
    "principalWrittenOff": 0,
    "totalActualCostOfLoanForPeriod": 0,
    "totalDueForPeriod": 0,
    "totalInstallmentAmountForPeriod": 0,
    "totalOriginalDueForPeriod": 0,
    "totalOutstandingForPeriod": 0,
    "totalOverdue": 0,
    "totalPaidForPeriod": 0,
    "totalPaidInAdvanceForPeriod": 0,
    "totalPaidLateForPeriod": 0,
    "totalWaivedForPeriod": 0,
    "totalWrittenOffForPeriod": 0
   }
  ],
  "totalInterest": 0,
  "totalPrincipal": 0,
  "totalRepayment": 0,
  "upfrontFee": 0
 },
 "msg": "",
 "success": true
}

Confirm Order

params

Attribute	Data type	Required	Description
orderNo	`integer`	true	the order number
installPlanId	`string`	true	plan id

request

POST {BASE_URL}/open/op/order/{memberId}/confirm/{orderNo}/

curl -i -X POST '{BASE_URL}/open/op/order/{memberId}/confirm/{orderNo}/' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>'

Response

{
 "code": 0,
 "data": {
  "actTotalFee": 0,
  "closeReason": "",
  "closeTime": "",
  "createTime": "",
  "creditFee": 0,
  "creditPayNo": "",
  "creditPayStatusEnum": "",
  "creditPayTime": "",
  "depositFee": 0,
  "installPlanId": 0,
  "memberId": "",
  "orderNo": "",
  "orderProductList": [
   {
    "actTotalFee": 0,
    "brand": "",
    "createTime": "",
    "memberId": "",
    "orderNo": "",
    "productLogo": "",
    "productName": "",
    "productNo": "",
    "productNum": 0,
    "salePrice": 0,
    "skuDesc": "",
    "storeId": "",
    "totalFee": 0,
    "updateTime": ""
   }
  ],
  "orderStatusEnum": "",
  "outOrderNo": "",
  "payStatusEnum": "",
  "payTime": "",
  "prePayNo": "",
  "prePayTime": "",
  "prepayFee": 0,
  "storeId": "",
  "totalFee": 0,
  "upFrontFee": 0,
  "updateTime": ""
 },
 "msg": "",
 "success": true
}

Cancel Order

params

Attribute	Data type	Required	Description
orderNo	`integer`	true	the order number
reason	`string`	true	reason for cancellation

request

POST {BASE_URL}/open/op/order/{memberId}/cancelOrder

curl -i -X POST '{BASE_URL}/open/op/order/{memberId}/cancelOrder' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>'

Response

{
 "code": 0,
 "data": "",
 "msg": "",
 "success": true
}

Check Credit Status

request

GET {BASE_URL}/open/op/order/{memberId}/checkCreditStatus/{orderNo}

curl -i -X GET '{BASE_URL}/open/op/order/{memberId}/checkCreditStatus/{orderNo}' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>'

Response

{
 "code": 0,
 "data": {
  "actTotalFee": 0,
  "closeReason": "",
  "closeTime": "",
  "createTime": "",
  "creditFee": 0,
  "creditPayNo": "",
  "creditPayStatusEnum": "",
  "creditPayTime": "",
  "depositFee": 0,
  "installPlanId": 0,
  "memberId": "",
  "orderNo": "",
  "orderProductList": [
   {
    "actTotalFee": 0,
    "brand": "",
    "createTime": "",
    "memberId": "",
    "orderNo": "",
    "productLogo": "",
    "productName": "",
    "productNo": "",
    "productNum": 0,
    "salePrice": 0,
    "skuDesc": "",
    "storeId": "",
    "totalFee": 0,
    "updateTime": ""
   }
  ],
  "orderStatusEnum": "",
  "outOrderNo": "",
  "payStatusEnum": "",
  "payTime": "",
  "prePayNo": "",
  "prePayTime": "",
  "prepayFee": 0,
  "storeId": "",
  "totalFee": 0,
  "upFrontFee": 0,
  "updateTime": ""
 },
 "msg": "",
 "success": true
}

Accept contract

request

GET {BASE_URL}/open/op/order/{memberId}/acceptContract/{orderNo}

curl -i -X GET '{BASE_URL}/open/op/order/{memberId}/acceptContract/{orderNo}' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>'

Response

{
 "code": 0,
 "data": {},
 "msg": "",
 "success": true
}

Reject contract

request

GET {BASE_URL}/open/op/order/{memberId}/rejectContract/{orderNo}

curl -i -X GET '{BASE_URL}/open/op/order/{memberId}/rejectContract/{orderNo}' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Content-Type: application/json' \
  -H 'Noncestr: <none>' \
  -H 'Sign: <sign>' \
  -H 'Timestamp: <timestamp>'

Response

{
 "code": 0,
 "data": {},
 "msg": "",
 "success": true
}

The Order Object​

Attributes​

Product List Attributes​

API request​

Request object​

JSON response​

Get Order Details​

params​

request​

Response​

Get Repayment Schedule​

params​

request​

Response​

Confirm Order​

params​

request​

Response​

Cancel Order​

params​

request​

Response​

Check Credit Status​

request​

Response​

Accept contract​

request​

Response​

Reject contract​

request​

Response​

The Order Object

Attributes

Product List Attributes

API request

Request object

JSON response

Get Order Details

params

request

Response

Get Repayment Schedule

params

request

Response

Confirm Order

params

request

Response

Cancel Order

params

request

Response

Check Credit Status

request

Response

Accept contract

request

Response

Reject contract

request

Response