Checkout Event

  • amount_centile
    Type: integer
    required

    A total centile amount for the checkout in the iso_currency.

  • campaign_id
    Type: integer
    required

    Tola Identifier for a particular stream of traffic.

  • checkout_reference
    Type: string
    required

    A Tola generated unique reference for the checkout session.

  • date_created
    Type: string
    required

    Date and time when the checkout session was created in UTC.

  • date_finalised
    Type: string
    required

    Date and time when the funds were collected in UTC.

  • initiator
    Type: object
    required

    Details about the entity that created this Checkout request.

    • reference
      Type: string
      required

      Idempotent key specified by the merchant in the checkout request.

    • type
      enum
      required

      Tola enumeration for how the checkout was initiated.

      values
      • merchant-checkout
      • reusable-payment-link
    • metadata
      Type: object

      The metadata object if supplied when creating the webcheckout, null otherwise.

      Example:

      metadata: {
    "trackingRegion": "Kenya"
    "trackingId": "5",
}
  • iso_currency
    Type: string
    required

    The ISO 4217 currency code for this Checkout

  • items
    Type: array object[]
    required
    • amountCentile
      Type: integer
      min:  
      1
      required

      A centile amount for the item in the currency specified for the checkout request.

    • description
      Type: string
      min length:  
      1
      required

      A textual description of the item being purchased.

    • productCode
      Type: string
      required

      Associated product code with the item if specfied in the checkout request. Null if not specified in checkout request.

    • quantity
      Type: integer
      min:  
      1
      required

      The number of the specified item.

  • status
    enum
    required

    The finalised status of the checkout, funds-transferred can be intrepreted as a success, all other status can be considered as a failure to collect funds.

    values
    • cancelled
    • funds-transferred
    • no-more-attempts
    • timeout-expired
    • system-error
  • customer_remark
    Type: string

    Contains the value of the customer remark provided at the Checkout creation time or an empty string if not supplied.

  • fulfillment_details
    Type: array object[]

    Array of collection attempts ordered by time ascending.

    • channel
      Type: string
      required

      The payment supplier details.

    • reference
      Type: string
      required

      The Tola unique transaction reference for a collection attempt initiated by this checkout session.

    • status
      Type: string
      required

      The status of the transaction on the Tola platform via which a payment collection was attempted.

    • supplier_account
      Type: string
      required

      The supplier account identifier on the Tola platform.

    • supplier_reference
      Type: string
      required

      The referene provided by the payment supplier.

    • type
      enum
      required
      values
      • charge
      • cardcollection
  • payer
    Type: object

    Information about the identified consumer that completed the checkout, null when payer information is not available.

    • confirmed_channel
      Type: string
      required

      The identified payment supplier for the payer.

    • id
      Type: string
      required
    • type
      enum
      required
      values
      • msisdn
      • card
Examples 
{
  "amount_centile": 2000,
  "campaign_id": 123,
  "checkout_reference": "00FDPZJP3A5",
  "customer_remark": "",
  "date_created": "2024-11-26T12:32:35Z",
  "date_finalised": "2024-11-26T12:35:32Z",
  "fulfillment_details": [
    {
      "channel": "KENYA.SAFARICOM",
      "supplier_reference": "XKQ679SM1Z",
      "supplier_account": "123456_KE",
      "reference": "9.932.1732624452.1",
      "status": "ok",
      "type": "charge"
    }
  ],
  "initiator": {
    "reference": "fbe8z0db-8x69-4dcb-b5eb-c7f5927af17e",
    "type": "merchant-checkout",
    "metadata": null
  },
  "iso_currency": "KES",
  "items": [
    {
      "amountCentile": 2000,
      "description": "Customer Entry",
      "productCode": "",
      "quantity": 1
    }
  ],
  "payer": {
    "confirmed_channel": "KENYA.SAFARICOM",
    "id": "254000000001",
    "type": "msisdn"
  },
  "status": "funds-transferred",
  "user_comments": {
    "key": "",
    "value": ""
  }
}