---
agentTools:
  projectIndex: https://developer.flutterwave.com/llms.txt
---

# Zambia Mobile Money

This document describes how to collect payments via Zambia mobile money.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Flutterwave v3",
    "version": "3.0.0"
  },
  "servers": [
    {
      "url": "https://api.flutterwave.com/v3"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/charges?type=mobile_money_zambia": {
      "post": {
        "summary": "Zambia Mobile Money",
        "description": "This document describes how to collect payments via Zambia mobile money.",
        "operationId": "charge-via-zambia-mobile-money",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Pass your secret key as a bearer token in the request header to authorize this call",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "amount",
                  "currency",
                  "email",
                  "tx_ref",
                  "network",
                  "phone_number"
                ],
                "properties": {
                  "amount": {
                    "type": "integer",
                    "description": "This is the amount to be charged.",
                    "default": 1500,
                    "format": "int32"
                  },
                  "currency": {
                    "type": "string",
                    "description": "This is the specified currency to charge in. (expected value: ZMW)",
                    "default": "ZMW"
                  },
                  "email": {
                    "type": "string",
                    "description": "This is the email address of the customer",
                    "default": "user@flw.com"
                  },
                  "tx_ref": {
                    "type": "string",
                    "description": "This is a unique reference, unique to the particular transaction being carried out.",
                    "default": "MC-3243e"
                  },
                  "network": {
                    "type": "string",
                    "description": "This is the customer's mobile money network provider, possible values are `MTN` `ZAMTEL`",
                    "default": "MTN",
                    "enum": [
                      "MTN",
                      "Airtel",
                      "Zamtel"
                    ]
                  },
                  "phone_number": {
                    "type": "string",
                    "description": "This is the phone number linked to the customer's mobile money account",
                    "default": "054709929220"
                  },
                  "order_id": {
                    "type": "string",
                    "description": "Unique identifier for the mobilemoney transaction to be provided by the merchant",
                    "default": "URF_MMGH_1585323540079_5981535"
                  },
                  "fullname": {
                    "type": "string",
                    "description": "This is the customers full name. It should include first and last name of the customer",
                    "default": "John Doe"
                  },
                  "client_ip": {
                    "type": "string",
                    "description": "IP - Internet Protocol. This represents the current IP address of the customer carrying out the transaction",
                    "default": "154.123.220.1"
                  },
                  "device_fingerprint": {
                    "type": "string",
                    "description": "This is the fingerprint for the device being used. It can be generated using a library on whatever platform is being used",
                    "default": "62wd23423rq324323qew1"
                  },
                  "meta": {
                    "type": "object",
                    "description": "This is used to include additional payment information",
                    "properties": {
                      "flightID": {
                        "type": "string",
                        "description": "This could be the extra information you want to pass"
                      },
                      "sideNote": {
                        "type": "string",
                        "description": "This could be any message you'd like to associate with this call"
                      }
                    }
                  }
                }
              },
              "examples": {
                "Sample Request Object": {
                  "value": {
                    "tx_ref": "MC-15852113s09v5050e8",
                    "amount": "1500",
                    "currency": "ZMW",
                    "email": "user@flw.com",
                    "phone_number": "054709929220",
                    "network": "MTN",
                    "fullname": "John Madakin",
                    "order_id": "URF_MMGH_1585323540079_5981535"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"message\": \"Charge initiated\",\n    \"meta\": {\n        \"authorization\": {\n            \"redirect\": \"https://ravemodal-dev.herokuapp.com/captcha/verify/144:16cbc719bf66ded37d5522de185f6a58\",\n            \"mode\": \"redirect\"\n        }\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "example": "Charge initiated"
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "authorization": {
                          "type": "object",
                          "properties": {
                            "redirect": {
                              "type": "string",
                              "example": "https://ravemodal-dev.herokuapp.com/captcha/verify/144:16cbc719bf66ded37d5522de185f6a58"
                            },
                            "mode": {
                              "type": "string",
                              "example": "redirect"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "5e36e596fe0cf5005142f849:5e7e98f389cc720024cc0042"
}
```