• Dashboard
  • Dashboard
Expand All Collapse All
  • Welcome
  • Introduction
  • API Access Key and Authentication
  • Nairagram Response Codes
  • Test Data
    • Test Bank Account Numbers
    • Test Data for Mobile Wallet Transfer
  • Implementing Nairagram Services
    • Bank Account Transfer Services
      • Submitting a transfer via Nairagram Payout API
      • Submitting a transfer via dashboard
      • Cancel Pending Request
    • Mobile Wallet Transfer
      • Submit Mobile Wallet Transaction
    • Cash Pick-up
      • Submit Cash Pick Up Transaction
      • Get Cash Pick-up locations
    • Client Support
      • Get Wallet by Country
      • Bank List
      • Operator Wallet Code
      • Cash Pick-up Locations
      • Webhook/Call back
      • Get Beneficiary Name
      • Get Bank List
      • Get Security Questions
      • Get Currency Rate
      • Get Country List
      • Get Balance
      • Get Transaction Status
  • User Acceptance Complete Testing (UAT)

Submit Mobile Wallet Transaction

203 views 0 Updated on September 14, 2023

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.

NumberCarrierCountry
7086543211—Nigeria
577916900TigoGhana
265543343AirtelGhana
552645758MTNGhana
508224845VodafoneGhana
722000000SafaricomKenya
763555496EquitelKenya
779000000MTNUganda

Input Parameters

The following table lists the parameters that you need to provide in the submitWalletTransaction request.

FieldValue FormatRequired/OptionalDescription
usernamemail@mail.comRequiredInput the valid email address that you submitted to your Partner Company.
passwordyourPasswordRequiredInput your secure password.
secretKeyyourSerectKeyRequiredInput the API key provided to you by your Partner Company.
senderfirstnamefirstNameRequiredInput the first name of the sender. For example, Jane.
senderlastnamelastNameRequiredInput the last name of the sender. For example, Doe.
senderemailsendermail@mail.comRequiredInput the email address of the sender.
senderphone07011111111RequiredInput the valid phone number of the sender. When unavailable, use the default phone number: 11111111111.
senderaddressNo 5, Address streetRequiredInput the valid address of the sender.
sendercountryUSRequiredInput the code for the sender’s country in ISO ALPHA-2 format. For example, US, GB, CA.
sendercityDallasRequiredInput the name of the sender’s city.
sendfromstateTXRequiredInput a 2-letter abbreviation of the sender’s state. For example, TX, NY, WA. Non-US default: 01.
senderpostalcode178980RequiredInput the sender’s postal code.
dateofbirth1968-02-05RequiredInput the date of birth of the sender in the valid format: YYYY-MM-DD.
tofirstnamebeneficiaryFirstNameRequiredInput the beneficiary’s first name. For example, John.
tolastnamebeneficiaryLastNameRequiredInput the beneficiary’s last name. For example, Doe.
tocountryUGRequiredInput the code for the beneficiary’s country in ISO ALPHA-2 format. For example, NG, GH, KE.
tophone7086543211RequiredPlease do not include the country code. For example, +221
walletMTNRequiredInput the valid name of the wallet operator. For example, MTN, Airtel, etc.
fromamount300RequiredInput an amount to send. The minimum value is $10 USD.
exchangerate454Optional Input the exchange rate.
fees10Optional Input the fees. The default fee is 0 unless specified.
transaction_number123456784568RequiredIndicates the transaction number that can be of 10 to 25 characters.
fromcurrencyUSDRequiredIt 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
  }
}

Was this helpful?

Yes  No

Didn't find your answer? Contact Us

Previously
Mobile Wallet Transfer
Up Next
Cash Pick-up
Recent Topics
  • Get Currency Rate
  • Submit Cash Pick Up Transaction
  • Submit Mobile Wallet Transaction
  • Webhook/Call back
  • Submitting a transfer via Nairagram Payout API
Popular Topics
  • Submitting a transfer via dashboard
  • Welcome
  • Test Data for Mobile Wallet Transfer
  • Client Support
  • Get Security Questions
©2022 - Nairagram Ltd. All rights reserved.