Collection
API change historyEnable remote automatic collection of bills, fees or taxes
GSMAAccountStatus
This operation is used to check the status of an account in the system. This is an alternative interface to GET /v1_0/accountholder///active
Try itRequest
Request URL
Request parameters
-
string
The account identifier id. valid values: accountid, msisdn, identityalias, emailaddress. Other identifier specified in the GSMS MM API specification are not supported
-
string
The account identifier id. Validated with IsRestricted key, Min length: 1, Max length: 256.Further validation based on identifier type: accountid: IsUUID msisdn: IsMsisdn. identityalias: ISAlias emailaddress: IsEmail
Request headers
-
(optional)string
Bearer Authentication Token generated using CreateAccessToken API Call
-
string
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that initiates the transaction.This parameter corresponds to X-Target-Environment parameter
Request body
Responses
200 OK
OK. Note that a failed request will be returned with this status too
Representations
{
"accountStatus": "string"
}{
"type": "object",
"properties": {
"accountStatus": {
"type": "string",
"description": "The status of the account. Valid values: available, unavailable"
}
},
"x-apim-inline": true
}400 Bad Request
Bad request, e.g invalid data was sent in the request
Representations
{
"errorCategory": "Validation",
"errorCode": "string",
"errorDescription": "String",
"errorDateTime": "Timestamp"
}{
"type": "object",
"properties": {
"errorCategory": {
"enum": [
"BusinessRule",
"Validation",
"Authorisation",
"Identification",
"internal",
"ServiceUnavailable"
],
"type": "string",
"description": "The category grouping for the error"
},
"errorCode": {
"enum": [
"GenericError",
"DailyVolumeLimitExceeded",
"DailyValueLimitExceeded",
"WeeklyVolumeLimitExceeded",
"WeeklyValueLimitExceeded",
"MonthlyVolumeLimitExceeded",
"MonthlyValueLimitExceeded",
"AccountMaxTotalVolumeExceeded",
"AccountMaxTotalValueExceeded,LessThanTransactionMinValue",
"GreaterThanTransactionMaxValue",
"MaxBalanceExceeded",
"SamePartiesError",
"DuplicateRequest",
"InsufficientFunds",
"IncorrectState",
"UnderPaymentNotAllowed",
"OverPaymentNotAllowed",
"RateLimitError",
"TransactionTypeError",
"NoMandateAuthority",
"LinkViolation",
"CountryofOriginNotPermitted",
"NationalityNotPermitted",
"IdDocumentNotSupported",
"IssuingCountryNotSupported",
"QuoteHasExpired",
"IdentifierError",
"LengthError",
"FormatError",
"NegativeValue",
"CurrencyNotSupported",
"MandatoryValueNotSupplied",
"InvalidOffset",
"ClientAuthorisationError",
"RequestDeclined",
"ServicingPartyAuthorisationError",
"RequestingPartyAuthorisationError"
],
"type": "string",
"description": "The harmonized error code identifying the reason for error"
},
"errorDescription": {
"type": "string",
"description": "A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256"
},
"errorDateTime": {
"type": "string",
"description": "The time stamp indicating when the error occurred"
}
},
"x-apim-inline": true
}500 Internal Server Error
Internal Error. Note that if the retrieved request to pay has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.
Representations
{
"errorCategory": "Validation",
"errorCode": "string",
"errorDescription": "String",
"errorDateTime": "Timestamp"
}{
"type": "object",
"properties": {
"errorCategory": {
"enum": [
"BusinessRule",
"Validation",
"Authorisation",
"Identification",
"internal",
"ServiceUnavailable"
],
"type": "string",
"description": "The category grouping for the error"
},
"errorCode": {
"enum": [
"GenericError",
"DailyVolumeLimitExceeded",
"DailyValueLimitExceeded",
"WeeklyVolumeLimitExceeded",
"WeeklyValueLimitExceeded",
"MonthlyVolumeLimitExceeded",
"MonthlyValueLimitExceeded",
"AccountMaxTotalVolumeExceeded",
"AccountMaxTotalValueExceeded,LessThanTransactionMinValue",
"GreaterThanTransactionMaxValue",
"MaxBalanceExceeded",
"SamePartiesError",
"DuplicateRequest",
"InsufficientFunds",
"IncorrectState",
"UnderPaymentNotAllowed",
"OverPaymentNotAllowed",
"RateLimitError",
"TransactionTypeError",
"NoMandateAuthority",
"LinkViolation",
"CountryofOriginNotPermitted",
"NationalityNotPermitted",
"IdDocumentNotSupported",
"IssuingCountryNotSupported",
"QuoteHasExpired",
"IdentifierError",
"LengthError",
"FormatError",
"NegativeValue",
"CurrencyNotSupported",
"MandatoryValueNotSupplied",
"InvalidOffset",
"ClientAuthorisationError",
"RequestDeclined",
"ServicingPartyAuthorisationError",
"RequestingPartyAuthorisationError"
],
"type": "string",
"description": "The harmonized error code identifying the reason for error"
},
"errorDescription": {
"type": "string",
"description": "A textual description of the error. Validated with IsRestrictedString, Min length: 1, Max length: 256"
},
"errorDateTime": {
"type": "string",
"description": "The time stamp indicating when the error occurred"
}
},
"x-apim-inline": true
}Code samples
@ECHO OFF
curl -v -X GET "https://ericssondeveloperapi.azure-api.net/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status"
-H "Authorization: "
-H "X-Account-Holding-Institution-Identifier: "
-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-Account-Holding-Institution-Identifier", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://ericssondeveloperapi.azure-api.net/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // 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://ericssondeveloperapi.azure-api.net/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "");
request.setHeader("X-Account-Holding-Institution-Identifier", "");
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://ericssondeveloperapi.azure-api.net/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("X-Account-Holding-Institution-Identifier","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// 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://ericssondeveloperapi.azure-api.net/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status";
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:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"" forHTTPHeaderField:@"X-Account-Holding-Institution-Identifier"];
[_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://ericssondeveloperapi.azure-api.net/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'X-Account-Holding-Institution-Identifier' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// 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-Account-Holding-Institution-Identifier': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('ericssondeveloperapi.azure-api.net')
conn.request("GET", "/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status?%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-Account-Holding-Institution-Identifier': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('ericssondeveloperapi.azure-api.net')
conn.request("GET", "/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status?%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://ericssondeveloperapi.azure-api.net/collection/v1_2/mm/accounts/{identifierType}/{Identifier}/status')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['X-Account-Holding-Institution-Identifier'] = ''
# 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