Overview of the hosted checkout API response object.

Shown below is a sample responses of a Hosted Checkout API.

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "order_id": "v1-5757575757-aa-hU1rUd",
  "redirect_url": "https://api.pluralonline.com/api/v3/checkout-bff/redirect/checkout?token=<<Redirect Token>>",
  "response_code": 200,
  "response_message": "Order Creation Successful."
}

The table below lists the various parameters returned in the Hosted checkout response object.

ParameterTypeDescription
tokenstringToken generate by our system for Plural Hosted Checkout.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
order_idstringUnique identifier of the order in the Plural database.

Example: v1-5757575757-aa-hU1rUd
redirect_urlstringThe checkout link generate on our system.

Example: <https://api.pluralonline.com/api/v3/checkout-bff/redirect/checkout?token=><<Redirect Token>
response_codeintegerResponse code of the request.

Example: 200
response_messagestringCorresponding message to the response code.

Example: Order Creation Successful