Mobile Money Event

This payload is used in two cases:

  1. in the Events API when the event.metadata.payload_format is "mobile-money"
  2. in the Create Transaction Callback when callbacks are enabled
  • amount
    Type: string
    max length:  
    16
    required

    The value of the transaction in cents. For example 1 KES would be 100

  • amounttype
    enum
    const:  
    centile
    required

    Tola only uses centile values

    values
    • centile
  • campaignid
    Type: string
    max length:  
    32
    required

    Identifies a particular stream of traffic, eg. Lodgements on Paybill 00001, or Transactions created by a given Relay Endpoint

  • channel
    Type: string
    max length:  
    32
    required

    The API identifier in the format '<COUNTRY>.<OPERATOR>'

  • currency
    Type: string
    min length:  
    3
    max length:  
    3
    required

    The ISO 4217 currency code for this Transaction

  • customerreference
    Type: string
    max length:  
    32
    required

    For type = notification, this will contain the reference you provided when calling POST /transaction.

    For type = lodgement, this will contain the text entered by the consumer on their handset when performing the lodgement.

  • date
    Type: string Format: date-time
    required

    The Date that the transaction was created (ISO 8601 UTC)

  • msisdn
    Type: string
    max length:  
    16
    required

    The MSISDN for the Transaction, in full international format

  • operatorreference
    Type: string
    max length:  
    32
    required

    The unique reference provided by the Operator for this transaction

  • reference
    Type: string
    max length:  
    32
    required

    The Tola.wallet platform reference of this notification

  • sourcereference
    Type: string
    max length:  
    32
    required

    For type=notification, the unique Tola reference of the originating Merchant request to Tola's POST /transaction.

  • success
    Type: string enum
    required

    The outcome of the funds-transfer where true indicates that funds were transferred.

    values
    • true
    • false
  • target
    Type: string
    max length:  
    16
    required

    The account identifier (or paybill number)

  • type
    Type: string enum
    required

    the type of notification. For a callback to a Charge or Disbursement this will always be 'notification'. See Lodgements for more informaton on the 'lodgement' type

    values
    • notification
    • lodgement
  • errorcode
    Type: integer

    an error code, only supplied when success is equal to "false". See Error Codes List

  • errormessage
    Type: string
    max length:  
    32

    an error message, only supplied when success is equal to "false". See Error Codes List

Examples 
{
  "reference": "1.123.1435455096.2",
  "success": "false",
  "sourcereference": "1.123.1435455096.1",
  "customerreference": "8FD2KuZNJnBPLKmz",
  "operatorreference": "CI220530.1717.A38729",
  "channel": "KENYA.SAFARICOM",
  "target": "000001",
  "date": "2022-05-30T17:19:01Z",
  "type": "notification",
  "currency": "KES",
  "amount": "100",
  "amounttype": "centile",
  "msisdn": "254000000001",
  "errorcode": 5,
  "errormessage": "insufficientfunds",
  "campaignid": "10001"
}