Use the submitWalletTransaction endpoint to make an international transaction associated with the mobile number and get a transaction PIN.
A mobile wallet is a virtual wallet that can receive a limited amount of cash—for example, Mpesa is available in Ghana, Uganda, and Kenya. Make a request from the business team for any new countries added to the list.
Please provide a call-back URL that can be used to timely notify you of any change in the transaction status.
If the response message states “Limit Exceeded or Company Limit Exceeded,” do not re-submit or re-process the transaction as such transaction would already have been queued up on your Partner Company platform. This happens because your company limit may have been exhausted and needs the client’s funding (not your Partner Company).
If the response message states “Wallet holding Limit Exceeded,” the beneficiary wallet cannot accept the funds at this moment as its holding limit has been exhausted. The sender would need to inform the beneficiary to reduce the balance in the wallet before the transaction can be completed. Do not re-submit or re-process the transaction as such transaction would already have been queued up on the Nairagram basket platform.
Syntax
POST https://nairagrambasket.com/api/submitWalletTransaction
Test Numbers
The following table lists the mobile wallet numbers used for testing.
Number | Carrier | Country |
---|---|---|
7086543211 | — | Nigeria |
577916900 | Tigo | Ghana |
265543343 | Airtel | Ghana |
552645758 | MTN | Ghana |
508224845 | Vodafone | Ghana |
722000000 | Safaricom | Kenya |
763555496 | Equitel | Kenya |
779000000 | MTN | Uganda |
Input Parameters
The following table lists the parameters that you need to provide in the submitWalletTransaction request.
Field | Value Format | Required/Optional | Description |
---|---|---|---|
username | mail@mail.com | Required | Input the valid email address that you submitted to your Partner Company. |
password | yourPassword | Required | Input your secure password. |
secretKey | yourSerectKey | Required | Input the API key provided to you by your Partner Company. |
senderfirstname | firstName | Required | Input the first name of the sender. For example, Jane. |
senderlastname | lastName | Required | Input the last name of the sender. For example, Doe. |
senderemail | sendermail@mail.com | Required | Input the email address of the sender. |
senderphone | 07011111111 | Required | Input the valid phone number of the sender. When unavailable, use the default phone number: 11111111111. |
senderaddress | No 5, Address street | Required | Input the valid address of the sender. |
sendercountry | US | Required | Input the code for the sender’s country in ISO ALPHA-2 format. For example, US, GB, CA. |
sendercity | Dallas | Required | Input the name of the sender’s city. |
sendfromstate | TX | Required | Input a 2-letter abbreviation of the sender’s state. For example, TX, NY, WA. Non-US default: 01. |
senderpostalcode | 178980 | Required | Input the sender’s postal code. |
dateofbirth | 1968-02-05 | Required | Input the date of birth of the sender in the valid format: YYYY-MM-DD. |
tofirstname | beneficiaryFirstName | Required | Input the beneficiary’s first name. For example, John. |
tolastname | beneficiaryLastName | Required | Input the beneficiary’s last name. For example, Doe. |
tocountry | UG | Required | Input the code for the beneficiary’s country in ISO ALPHA-2 format. For example, NG, GH, KE. |
tophone | 7086543211 | Required | Please do not include the country code. For example, +221 |
wallet | MTN | Required | Input the valid name of the wallet operator. For example, MTN, Airtel, etc. |
fromamount | 300 | Required | Input an amount to send. The minimum value is $10 USD. |
exchangerate | 454 | Optional | Input the exchange rate. |
fees | 10 | Optional | Input the fees. The default fee is 0 unless specified. |
transaction_number | 123456784568 | Required | Indicates the transaction number that can be of 10 to 25 characters. |
fromcurrency | USD | Required | It can also be the settlement currency, For example, USD, GBP, CAD, EUR. |
Sample Request
curl --location --request POST 'https://nairagrambasket.com/api/submitWalletTransaction' \
--form 'username="mail@mail.com"' \
--form 'password="yourPassword"' \
--form 'secretKey="yourSerectKey"' \
--form 'senderfirstname="firstName"' \
--form 'senderlastname="lastName"' \
--form 'senderemail="sendermail@mail.com"' \
--form 'senderphone="07011111111"' \
--form 'senderaddress="No 5, Address street"' \
--form 'sendercountry="US"' \
--form 'sendercity="Dallas"' \
--form 'sendfromstate="TX"' \
--form 'senderpostalcode="178980"' \
--form 'dateofbirth="1968-02-05"' \
--form 'tofirstname="beneficiaryFirstName"' \
--form 'tolastname="beneficiaryLastName"' \
--form 'tocountry="NG"' \
--form 'tophone="7086543211"' \
--form 'wallet="MTN"' \
--form 'fromamount="300"' \
--form 'exchangerate="454"' \
--form 'fees="10"' \
--form 'transaction_number="123456784568"' \
--form 'fromcurrency="USD"' \
--form 'settlement_currency="USD"'
Sample Response
{
"Code": "200",
"Message": "Success",
"Content": {
transaction_pin: NGN1234567890
}
}