Collection

API change history

Enable remote automatic collection of bills, fees or taxes

GSMATransactionStatus

This operation is used to get the status of a transaction. This is an alternative interface toGET /v1_0/transfer/ and GET /v1_0/merchantPay/

Try it

Request

Request URL

Request parameters

  • string

    A reference to the transaction. This can either be the reference id which was provided in the X-CorrelationID header of the POST transaction request or the financial transaction id. Is either a UUID or a number. Min length: 1, Max length: 256.

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

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

OK. Note that a failed request will be returned with this status too. The 'status' of the RequestToPayResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.

Representations

{
  "requestingOrganisationTransactionReference": "TransferReferenceID",
  "debitParty": [
    {
      "key": "accountid",
      "value": "{{pheterApiUser}}"
    }
  ],
  "creditParty": [
    {
      "key": "identityalias",
      "value": "shop"
    }
  ],
  "amount": "2023-10-12",
  "currency": "EUR",
  "descriptionText": "Some text with a description.",
  "customData": [
    {
      "key": "ownnote",
      "value": "This is a note."
    }
  ]
}
{
  "type": "object",
  "properties": {
    "transactionReference": {
      "type": "string",
      "description": "Unique reference for the transaction.Validated with IsRestrictedString. Min length: 1, Max length: 256"
    },
    "transactionStatus": {
      "type": "string",
      "description": "The status of the transaction. One of pending, successful, failed. Validated with IsRestrictedString. Min length: 1, Max length: 25"
    },
    "amount": {
      "type": "string",
      "description": "The monetary amount of the transaction.\\nValidated with IsAmount Min length = 1, max = 23."
    },
    "currency": {
      "type": "string",
      "description": "The currency of the transaction. A three letter currency code. For supported currencies, see the GSMA MM API specification"
    },
    "creditParty": {
      "type": "array",
      "items": {
        "required": [
          "key",
          "value"
        ],
        "type": "object",
        "properties": {
          "key": {
            "enum": [
              "accountid",
              "msisdn",
              "identityalias",
              "emailaddress",
              "walletid",
              "consumerno"
            ],
            "type": "string"
          },
          "value": {
            "type": "object",
            "properties": {
              "accountid": {
                "type": "string",
                "description": "Equivalent of PARTY_CODE in Wallet Paltform.\\nAn ID connected to a registered API user."
              },
              "msisdn": {
                "type": "string",
                "description": "Equivalent of MSISDN in Wallet Paltform.\\nThe MSISDN of an account holder."
              },
              "identityalias": {
                "type": "string",
                "description": "Equivalent of ALIAS in Wallet Paltform.\\nAn alias which is connected to an account holder."
              },
              "emailaddress": {
                "type": "string",
                "description": "Equivalent of EMAIL in Wallet Paltform.\\nThe email address of an account holder."
              },
              "walletid": {
                "type": "string",
                "description": "Equivalent of ACCOUNT_ID in Wallet Paltform.\\nThe FRI ID of an MM account in Wallet Platform.\\nExample: Given FRI: 123456789/MM, the walletid is 123456789."
              },
              "consumerno": {
                "type": "string",
                "description": "Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\\nThe ID of an account holder in Wallet Platform.\\nExample: Given ID: 987654321/ID, the consumerno is 987654321."
              }
            }
          }
        }
      },
      "description": "The account holder that the funds are sent to\\nThis parameter corresponds to the payee parameter in a requesttopay request\\nTransaction is rejected if a creditParty is provided and the party is not the same as the API user\\n Only account identifiers of type accountid are allowed.Min list size: 1, Max list size: 10\\nIf more than one entry is provided the first valid entry is used."
    },
    "debitParty": {
      "type": "array",
      "items": {
        "required": [
          "key",
          "value"
        ],
        "type": "object",
        "properties": {
          "key": {
            "enum": [
              "accountid",
              "msisdn",
              "identityalias",
              "emailaddress",
              "walletid",
              "consumerno"
            ],
            "type": "string"
          },
          "value": {
            "type": "object",
            "properties": {
              "accountid": {
                "type": "string",
                "description": "Equivalent of PARTY_CODE in Wallet Paltform.\\nAn ID connected to a registered API user."
              },
              "msisdn": {
                "type": "string",
                "description": "Equivalent of MSISDN in Wallet Paltform.\\nThe MSISDN of an account holder."
              },
              "identityalias": {
                "type": "string",
                "description": "Equivalent of ALIAS in Wallet Paltform.\\nAn alias which is connected to an account holder."
              },
              "emailaddress": {
                "type": "string",
                "description": "Equivalent of EMAIL in Wallet Paltform.\\nThe email address of an account holder."
              },
              "walletid": {
                "type": "string",
                "description": "Equivalent of ACCOUNT_ID in Wallet Paltform.\\nThe FRI ID of an MM account in Wallet Platform.\\nExample: Given FRI: 123456789/MM, the walletid is 123456789."
              },
              "consumerno": {
                "type": "string",
                "description": "Equivalent of ACCOUNT_HOLDER_ID in Wallet Paltform.\\nThe ID of an account holder in Wallet Platform.\\nExample: Given ID: 987654321/ID, the consumerno is 987654321."
              }
            }
          }
        }
      },
      "description": "The account holder that the funds are withdrawn from.\\nThis parameter corresponds to the payer parameter in a requesttopay request.\\nMin list size: 1, Max list size: 10\\nIf more than one entry is provided the first valid entry is used."
    },
    "type": {
      "type": "string",
      "description": "The transaction type. Valid values: merchantpay, disbursement, transfer"
    },
    "descriptionText": {
      "type": "string",
      "description": "A description text which is visible for the creditParty. This parameter corresponds to the payerMessage parameter in a requesttopay result. This parameter corresponds to the payeeNote parameter in a transfer result. Validated with IsRestrictedString. Max length: 16"
    },
    "customData": {
      "type": "array",
      "items": {
        "required": [
          "key",
          "value"
        ],
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "A key used to identify the custom data. Different operation supports different custom data keys. Validated with IsRestrictedString. Min length: 1, Max length: 256"
          },
          "value": {
            "type": "string",
            "description": "The custom data value. What this value is used for is decided by the key and how the operation. Handles that key. Validated with IsRestrictedString, Min length: 1, Max length: 256."
          }
        }
      },
      "description": "A list of key and value custom data for the transaction. Only an entry with \"ownnote\" as key is used. All other entries are ignored and have no impact on the transaction. The ownnote entry corresponds to the payeeNote parameter in a requesttopay request. Max list size: 20"
    },
    "requestingOrganisationTransactionReference": {
      "type": "string",
      "description": "External transaction id in Wallet Platform. Included in transaction history. This parameter corresponds to the externalId parameter in, for example, a requesttopay result. This parameter corresponds to the externalId parameter in a transfer result. Validated with IsRestrictedString, Max length: 256"
    }
  },
  "x-apim-inline": true
}

400 Bad Request

Bad request, e.g. an incorrectly formatted reference id was provided.

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
}

404 Not Found

Resource not found.

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/Transactions/{TransactionReference}"
-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/Transactions/{TransactionReference}?" + 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/Transactions/{TransactionReference}");


            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/Transactions/{TransactionReference}?" + $.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/Transactions/{TransactionReference}";
    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/Transactions/{TransactionReference}');
$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/Transactions/{TransactionReference}?%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/Transactions/{TransactionReference}?%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/Transactions/{TransactionReference}')


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