v2.1
Solutions
API DOCUMENTATION
Products
GUIDES
Mobile Money Payments
Mobile Money is a service that stores funds in a secure electronic account, linked to the user's mobile phone number. It is provided by the same companies that run the local mobile phone services and is available to both pre-pay and contract customers.
It allows users to store, send, and receive money using their mobile phone. They can buy items in shops or online, pay bills, school fees, and top up mobile airtime, and withdraw cash at authorized agents. Typically, the user's account with the telco includes two separate balances: phone call balances, and a wallet balance.
Mobile Money payments are available in Kenya, Ghana, Cameroon and Senegal
Push notification example flow
User will input the phone number in the merchant's website, and a mobile money payment request with
payment_method_id = MWwill be sent (see an example below).The response will have the
PENDING status until the user inputs the required PIN, and dLocal gets notified. This is an example of the push notification the user is receiving:
Example of mobile money push notification in Ghana
Mobile Money request
Mobile money payments are available trough a DIRECT flow only and, as mentioned above, make sure you set
payment_method_id = MW. For a full list of country and currency codes, visit the Country Reference page.There's a specific parameter that is particularly mandatory for Ghana. Find and example request/response after the first example.
Sending
phone is mandatory so that the user can receive the push notificationExample Request
Example response
Example request
1
{
2
"amount": 10000,
3
"currency": "KES",
4
"country": "KE",
5
"payment_method_flow": "DIRECT",
6
"payment_method_id": "MW",
7
"payer": {
8
"name": "David Otieno",
9
"email": "[email protected]",
10
"phone": "+2544832695335",
11
"document": "27183121",
12
"address": {
13
"country": "KE",
14
"state": "Nairobi",
15
"city": "Nairobi",
16
"zip_code": "2341",
17
"street": "Lusaka Rd",
18
"number": "5940"
19
}
20
},
21
"order_id": "9928451",
22
"notification_url": "http://google.com"
23
}
Copied!
1
{
2
"id": "D-4-a81b9060-3cde-452c-81b1-e82f2739fb47",
3
"amount": 10000,
4
"currency": "KES",
5
"payment_method_id": "MW",
6
"payment_method_type": "BANK_TRANSFER",
7
"payment_method_flow": "DIRECT",
8
"country": "KE",
9
"bank_transfer": {},
10
"ticket": {},
11
"created_date": "2020-11-03T14:09:24.000+0000",
12
"status": "PENDING",
13
"status_detail": "The payment is pending.",
14
"status_code": "100",
15
"order_id": "9928451",
16
"notification_url": "http://google.com"
17
}
Copied!
Mobile Money Request (for Ghana)
Particularly for Ghana, the mobile carrier is mandatory:
metadata.mobile_carrier. Possible values for that parameter are MTN, VODAFONE or TIGO.Example Request
Example Response
Request Example
1
​
2
{
3
"amount": 12.00,
4
"currency" : "GHS",
5
"country": "GH",
6
"payment_method_id" : "MW",
7
"payment_method_flow" : "DIRECT",
8
"payer":{
9
"name" : "David Otieno",
10
"email" : "[email protected]",
11
"phone": "+2544832695335",
12
"document" : "353033315550",
13
"user_reference": "12345",
14
"address": {
15
"state" : "Accra",
16
"city" : "Accra",
17
"zip_code" : "23321",
18
"street" : "Servidao B-1",
19
"number" : "1106"
20
},
21
"ip" : "179.27.83.210",
22
"device_id" : "2fg3d4gf234"
23
},
24
"metadata": {
25
"mobile_carrier": "MTN",
26
}
27
"order_id": "657434343",
28
"notification_url": "http://merchant.com/notifications"
29
}
Copied!
1
{
2
"id": "PAY2323243343543",
3
"amount": 12.00,
4
"currency" : "GHS",
5
"country": "GH",
6
"payment_method_id" : "MW",
7
"payment_method_type" : "BANK_TRANSFER",
8
"payment_method_flow" : "DIRECT",
9
"created_date" : "2018-02-15T15:14:52-00:00",
10
"status" : "PENDING",
11
"status_code" : "100",
12
"status_detail" : "The payment is pending.",
13
"order_id": "657434343",
14
"notification_url": "http://merchant.com/notifications"
15
}
Copied!
Last modified 1yr ago