Mobile Money Collection

post https://api.eversend.co/v1/collections/momo

This is for the momo collection for Kenya, Rwanda, Uganda and Ghana. The OTP object in the payload is an optional field, it's only needed when your business account isn't whitelisted for verifying phone numbers before collections, using the collection OTP endpoint. If you have a system in place to verify phone numbers in your app then reach out to us to whitelist your account so you can proceed to integrate this collection API without the need for a phone number verification endpoint(OTP collection)

Body Params

phone

string

required

Defaults to +256712345678

Phone number in international format

amount

int32

required

Defaults to 1000

Amount as a number

country

string

required

Defaults to UG

The country you are collecting from. Options are UG, KE, GH, RW, CM, CI, TZ

currency

string

required

Defaults to UGX

Currency you're collecting. Options are UGX, KES, GHS, RWF

customer

json

An optional JSON object with customer information e.g. '{"email":"john@example.com"}'

transactionRef

string

Defaults to ADR234526534

Optional unique alphanumeric string set by the client

otp

object

A JSON object with pinId from Get Collection OTP and pin from customer e.g {"pinId":"132466gdfsfsrey1535", "pin":"123456"}. NB: This is an optional field

redirectUrl

string

Defaults to https://eversend.co

This is required when your collection country is GH and currency is GHS. This is necessary so after phone number verification, it redirects the user back to your system after successful collection

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.eversend.co/v1/collections/momo \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "phone": "+256712345678",
8
  "amount": 1000,
9
  "country": "UG",
10
  "currency": "UGX",
11
  "transactionRef": "ADR234526534",
12
  "redirectUrl": "https://eversend.co"
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400