Skip to content

Base Types

Amount

Amounts of money must be round and positive numbers. They cannot contain decimal places nor be negative.

{
    amount : 15000
}

Phone Number

Phone numbers must be represented using a string that respects the E164 format. They must include a country code preceded by +.

{
    msisdn : "+22507XXXXXXXX"
}

Currency

The currency for an amount is string following standard ISO 4217 three-letter codes in upper case. If not specified the currency can be assumed to be XOF.

{
    currency : "XOF"
}

Timestamp

Dates and times are expressed using the ISO 8601 format.

  • The time zone is UTC.
  • The precision is in seconds.
  • The format is YYYY-MM-DDThh:mm:ssZ. Example: 2023-05-10T12:19:12Z.