Request MiMo API access
Before you can begin using the MiMo API you must request access for your client application. MiMo API access is only granted to fully-verified merchant users. These are users with a confirmed email address, a confirmed mobile number and who are KYC verified.
Your MiMo API access will have an associated "client_id" and "client_secret" which will be needed during the next steps.
Request user authentication code
When initiating a new payment from your client application, the user should be redirected to MiMo in order for the system to authenticate the user’s identity and allow him to accept the Terms of Service. The request must include the required information for a payment: client_id, amount, notes and the callback URL.
Once the user accepts or rejects the Merchant-Initiated Payment agreement, the user will be redirected back to the callback URL along with a user authentication code. The user authentication code does not expire since the user has granted you access to your application. A user may revoke this access at a later time. It is acceptable to cache the user authentication code so that you may use it to obtain access tokens later on.
|client_id||Client ID for the application which was provided by MiMo.|
|url||Callback URL to redirect the user to after they have approved or rejected the authentication request. If not provided, this will default to the registered OAuth Callback URL. The url parameter must be a full, valid URL.|
|amount||The transfer amount which the user will verify for the payment.|
|notes||The notes should include additonal information about the payment like an invoice number or similar. (Maximum of 255 characters.)|
|destination_user||This is an optional parameter which you can use to facilitate payments between two other MiMo users. The value for this should be a valid MiMo username.|
|response_type||MiMo uses the OAuth 'code' response type by default (OAuth Standards).|
After approving or rejecting the authentication request, the user will be redirected to the supplied callback URL along with a user authentication code. Note: this user authentication code is not your access token. The user authentication code returned on redirect is used to get a temporary access token.
|code||Returned on redirect to callback URL. This is a user authentication code which is used in the next step.|
Response format for a successful approval:
Response format for a failure or rejection: