Create Checkout Response

  • success
    Type: boolean
    required

    Indicates whether a checkout was successfully created or not. If false the error object will be present.

  • error
    Type: object

    A JSON object containing the error details, provided where it was not possilbe to initiate a checkout. See Error Codes List

    • code
      Type: integer
      required

      The numeric code for the error.

    • message
      Type: string
      required

      A human readable expression of the error code.

  • response
    Type: object

    Present when "success" is true.

    • checkoutReference
      Type: string
      required

      A Tola generated unique reference for the checkout session. This will be present in the "checkout_reference" field of a checkout event in the Events API response.

    • consumerURL
      Type: string
      required

      The URL to which the consumer should be re-directed to by the merchant on reception of a successful checkout API response. This page is served by Tola.

Examples 
{
  "response": {
    "checkoutReference": "00FF859C5TX",
    "consumerURL": "https://apidocs.tolamobile.com/c/123/00FF8X1C5TX"
  },
  "success": true
}