Calculate total price checkout

Calculate the total price of a package at checkout.

post

This method is used to calculate the total price of a package at checkout based on the provided package ID and the request data. It takes into account the wallet used, refund amount, prorate amount, subtotal, tax, and total price to be paid.

Path parameters

packageIdstringRequired

The ID of the package for which the total price is being calculated.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Represents a request to calculate the total price of a package.

priceIdstring · min: 1Required

The ID of the package to calculate the total price for.

walletIdstring · nullableOptional

The ID of the app integration payment gateway to use for the calculation.

couponCodestring · nullableOptional

The coupon code to apply for the price calculation, if any.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

post

/api/v1/packages/{packageId}/calculate-total-price-checkout

HTTPcURLJavaScriptPython

POST /api/v1/packages/{packageId}/calculate-total-price-checkout HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "priceId": "text",
  "walletId": "text",
  "couponCode": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "walletUsed": 2,
    "refundAmountWallet": 0,
    "prorateAmount": 10,
    "subtotal": 100,
    "tax": {
      "percent": 0,
      "amount": 0
    },
    "couponCode": null,
    "discountAmount": null,
    "total": 88,
    "currency": "USD"
  },
  "errors": []
}