Collection
API change historyPartner Gateway API document
Request
Request URL
Request headers
-
string
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.
-
(optional)string
PUT Callback URL to send callback to once the invoice is completed.
-
string
Format - UUID. An id to uniquely identify the making of an invoice
-
string
The desired target environment to use that is allowed for the API user.
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"payer": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerCurrency": "string(The currency code of the sending account. Amount to be paid.)",
"payerMessage": "string (Message to the end user.)",
"validityTime": "integer (The time duration in seconds that the pre-approval is valid once it is accepted.)"
}{
"type": "object",
"properties": {
"payer": {
"type": "object",
"properties": {
"partyIdType": {
"enum": [
"MSISDN",
"EMAIL",
"PARTY_CODE"
],
"type": "string"
},
"partyId": {
"type": "string"
}
},
"description": "Party identifies a account holder in the wallet platform. Party consists of two parameters, type and partyId. Each type have its own validation of the partyId<br> MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN<br> EMAIL - Validated to be a valid e-mail format. Validated with IsEmail<br> PARTY_CODE - UUID of the party. Validated with IsUuid"
},
"payerCurrency": {
"type": "string",
"description": "ISO4217 Currency"
},
"payerMessage": {
"type": "string",
"description": "The mesage that is shown to the approver."
},
"validityTime": {
"type": "integer",
"description": "The request validity time of the pre-approval"
}
}
}Responses
202 Accepted
Accepted
Representations
400 Bad Request
Bad request, e.g. invalid data was sent in the request.
Representations
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}{
"type": "object",
"properties": {
"code": {
"enum": [
"PAYEE_NOT_FOUND",
"PAYER_NOT_FOUND",
"NOT_ALLOWED",
"NOT_ALLOWED_TARGET_ENVIRONMENT",
"INVALID_CALLBACK_URL_HOST",
"INVALID_CURRENCY",
"SERVICE_UNAVAILABLE",
"INTERNAL_PROCESSING_ERROR",
"NOT_ENOUGH_FUNDS",
"PAYER_LIMIT_REACHED",
"PAYEE_NOT_ALLOWED_TO_RECEIVE",
"PAYMENT_NOT_APPROVED",
"RESOURCE_NOT_FOUND",
"APPROVAL_REJECTED",
"EXPIRED",
"TRANSACTION_CANCELED.",
"RESOURCE_ALREADY_EXIST",
"TRANSACTION_NOT_COMPLETED",
"TRANSACTION_NOT_FOUND",
"INFORMATIONAL_SCOPE_INSTRUCTION",
"MISSING_SCOPE_INSTRUCTION",
"MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
"UNSUPPORTED_SCOPE_COMBINATION",
"CONSENT_MISMATCH",
"UNSUPPORTED_SCOPE",
"NOT_FOUND"
],
"type": "string"
},
"message": {
"type": "string"
}
}
}409 Conflict
Conflict, duplicated reference id
Representations
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}{
"type": "object",
"properties": {
"code": {
"enum": [
"PAYEE_NOT_FOUND",
"PAYER_NOT_FOUND",
"NOT_ALLOWED",
"NOT_ALLOWED_TARGET_ENVIRONMENT",
"INVALID_CALLBACK_URL_HOST",
"INVALID_CURRENCY",
"SERVICE_UNAVAILABLE",
"INTERNAL_PROCESSING_ERROR",
"NOT_ENOUGH_FUNDS",
"PAYER_LIMIT_REACHED",
"PAYEE_NOT_ALLOWED_TO_RECEIVE",
"PAYMENT_NOT_APPROVED",
"RESOURCE_NOT_FOUND",
"APPROVAL_REJECTED",
"EXPIRED",
"TRANSACTION_CANCELED.",
"RESOURCE_ALREADY_EXIST",
"TRANSACTION_NOT_COMPLETED",
"TRANSACTION_NOT_FOUND",
"INFORMATIONAL_SCOPE_INSTRUCTION",
"MISSING_SCOPE_INSTRUCTION",
"MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
"UNSUPPORTED_SCOPE_COMBINATION",
"CONSENT_MISMATCH",
"UNSUPPORTED_SCOPE",
"NOT_FOUND"
],
"type": "string"
},
"message": {
"type": "string"
}
}
}{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}{
"type": "object",
"properties": {
"code": {
"enum": [
"PAYEE_NOT_FOUND",
"PAYER_NOT_FOUND",
"NOT_ALLOWED",
"NOT_ALLOWED_TARGET_ENVIRONMENT",
"INVALID_CALLBACK_URL_HOST",
"INVALID_CURRENCY",
"SERVICE_UNAVAILABLE",
"INTERNAL_PROCESSING_ERROR",
"NOT_ENOUGH_FUNDS",
"PAYER_LIMIT_REACHED",
"PAYEE_NOT_ALLOWED_TO_RECEIVE",
"PAYMENT_NOT_APPROVED",
"RESOURCE_NOT_FOUND",
"APPROVAL_REJECTED",
"EXPIRED",
"TRANSACTION_CANCELED.",
"RESOURCE_ALREADY_EXIST",
"TRANSACTION_NOT_COMPLETED",
"TRANSACTION_NOT_FOUND",
"INFORMATIONAL_SCOPE_INSTRUCTION",
"MISSING_SCOPE_INSTRUCTION",
"MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
"UNSUPPORTED_SCOPE_COMBINATION",
"CONSENT_MISMATCH",
"UNSUPPORTED_SCOPE",
"NOT_FOUND"
],
"type": "string"
},
"message": {
"type": "string"
}
}
}{
"type": "object",
"properties": {
"code": {
"enum": [
"PAYEE_NOT_FOUND",
"PAYER_NOT_FOUND",
"NOT_ALLOWED",
"NOT_ALLOWED_TARGET_ENVIRONMENT",
"INVALID_CALLBACK_URL_HOST",
"INVALID_CURRENCY",
"SERVICE_UNAVAILABLE",
"INTERNAL_PROCESSING_ERROR",
"NOT_ENOUGH_FUNDS",
"PAYER_LIMIT_REACHED",
"PAYEE_NOT_ALLOWED_TO_RECEIVE",
"PAYMENT_NOT_APPROVED",
"RESOURCE_NOT_FOUND",
"APPROVAL_REJECTED",
"EXPIRED",
"TRANSACTION_CANCELED.",
"RESOURCE_ALREADY_EXIST",
"TRANSACTION_NOT_COMPLETED",
"TRANSACTION_NOT_FOUND",
"INFORMATIONAL_SCOPE_INSTRUCTION",
"MISSING_SCOPE_INSTRUCTION",
"MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
"UNSUPPORTED_SCOPE_COMBINATION",
"CONSENT_MISMATCH",
"UNSUPPORTED_SCOPE",
"NOT_FOUND"
],
"type": "string"
},
"message": {
"type": "string"
}
}
}500 Internal Server Error
Internal Error.
Representations
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}{
"type": "object",
"properties": {
"code": {
"enum": [
"PAYEE_NOT_FOUND",
"PAYER_NOT_FOUND",
"NOT_ALLOWED",
"NOT_ALLOWED_TARGET_ENVIRONMENT",
"INVALID_CALLBACK_URL_HOST",
"INVALID_CURRENCY",
"SERVICE_UNAVAILABLE",
"INTERNAL_PROCESSING_ERROR",
"NOT_ENOUGH_FUNDS",
"PAYER_LIMIT_REACHED",
"PAYEE_NOT_ALLOWED_TO_RECEIVE",
"PAYMENT_NOT_APPROVED",
"RESOURCE_NOT_FOUND",
"APPROVAL_REJECTED",
"EXPIRED",
"TRANSACTION_CANCELED.",
"RESOURCE_ALREADY_EXIST",
"TRANSACTION_NOT_COMPLETED",
"TRANSACTION_NOT_FOUND",
"INFORMATIONAL_SCOPE_INSTRUCTION",
"MISSING_SCOPE_INSTRUCTION",
"MORE_THAN_ONE_FINANCIAL_SCOPE_NOT_SUPPORTED",
"UNSUPPORTED_SCOPE_COMBINATION",
"CONSENT_MISMATCH",
"UNSUPPORTED_SCOPE",
"NOT_FOUND"
],
"type": "string"
},
"message": {
"type": "string"
}
}
}Code samples
@ECHO OFF
curl -v -X POST "https://proxy.momoapi.mtn.com/collection/v2_0/preapproval"
-H "Authorization: "
-H "X-Callback-Url: "
-H "X-Reference-Id: "
-H "X-Target-Environment: "
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("X-Callback-Url", "");
client.DefaultRequestHeaders.Add("X-Reference-Id", "");
client.DefaultRequestHeaders.Add("X-Target-Environment", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://proxy.momoapi.mtn.com/collection/v2_0/preapproval?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://proxy.momoapi.mtn.com/collection/v2_0/preapproval");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Authorization", "");
request.setHeader("X-Callback-Url", "");
request.setHeader("X-Reference-Id", "");
request.setHeader("X-Target-Environment", "");
request.setHeader("Content-Type", "application/json");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://proxy.momoapi.mtn.com/collection/v2_0/preapproval?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("X-Callback-Url","");
xhrObj.setRequestHeader("X-Reference-Id","");
xhrObj.setRequestHeader("X-Target-Environment","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://proxy.momoapi.mtn.com/collection/v2_0/preapproval";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"" forHTTPHeaderField:@"X-Callback-Url"];
[_request setValue:@"" forHTTPHeaderField:@"X-Reference-Id"];
[_request setValue:@"" forHTTPHeaderField:@"X-Target-Environment"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://proxy.momoapi.mtn.com/collection/v2_0/preapproval');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'X-Callback-Url' => '',
'X-Reference-Id' => '',
'X-Target-Environment' => '',
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Authorization': '',
'X-Callback-Url': '',
'X-Reference-Id': '',
'X-Target-Environment': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('proxy.momoapi.mtn.com')
conn.request("POST", "/collection/v2_0/preapproval?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Authorization': '',
'X-Callback-Url': '',
'X-Reference-Id': '',
'X-Target-Environment': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('proxy.momoapi.mtn.com')
conn.request("POST", "/collection/v2_0/preapproval?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://proxy.momoapi.mtn.com/collection/v2_0/preapproval')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['X-Callback-Url'] = ''
# Request headers
request['X-Reference-Id'] = ''
# Request headers
request['X-Target-Environment'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body