GET Retrieve a Lite Transaction Status

`GET /disbursement/status/v1/transactions/lite/{transactionId}

Development Guide

The 'Retrieve a Lite Transaction Status' endpoint retrieves a disbursement by transactionId and returns a lite status of the transaction, including the transaction referenceNumber and quote. The endpoint is to be used in conjunction with Batch Disbursement models, when transaction are processed with high throughput.



1. Prepare headers, authentication and parameters:

The application must call the 'Retrieve a Transaction Status Summary' endpoint with a GET HTTP method, providing the OAuth access_token, required headers and parameter values.


Note: MoneyGram uses the OAuth 2.0 framework. The application must use their OAuth client credentials to generate an access_token by calling the Get Access Token endpoint. The token is valid for 1 hour and must be passed as a header value in all subsequent API HTTP calls. Learn More


🚀

Launch Code Example




2. Make a request and handle the response:

The application must call the 'Retrieve a Transaction Status Summary' endpoint with a GET HTTP method. The application must build to handle the following response scenarios:


  • Success | Parse the Response | 200 OK HTTP Status
    When the 'Retrieve a Transaction Status Summary' endpoint responds with a 200 HTTP Status the response will return the transactionId, and thetransactionSendDateTime.

  • Failed | Handle the Error | 400 Bad Request HTTP Status
    When the 'Retrieve a Transaction Status Summary' endpoint responds with 400 HTTP Status, specific error codes will be returned with an array of offending fields. The application will need to resolve these errors and resubmit the request.

🚀

Launch Code Example

.




3. You're Done! Communicate the transaction status to the business consumer:

The information returned can be used to display a Transaction Summary feature on the application UI. The transactionStatus is a top level transaction status. There is also a transactionSubStatus which provides more detail about the transaction status and any action needed by the consumer Learn More




Code Examples


const axios = require('axios');
const { v4: uuidv4 } = require('uuid');

const status = async () => {

    // Step 1: Read configuration values with upmost security
    const token = "your_access_token_from_oauth_response"
    // For production - api.moneygram.com & For test - sandboxapi.moneygram.com
    const host = "sandboxapi.moneygram.com";
    const url = 'https://' + host + '/disbursement/status/v1/transactions/lite';

    // Step 2: Create the GET request headers & params
    const headers = {
        'Content-Type': 'application/json',
        'X-MG-ClientRequestId': uuidv4(), // New UUID for each request tracing
        'Authorization': 'Bearer ' + token,
    };
    
    const transactionId = "current_transaction_id";
    const params = {
        agentPartnerId: "your_partner_id",        
        userLanguage: "en-US",
        targetAudience: "AGENT_FACING"
    }

    try {
        // Step 3: Send the request and obtain the response
        axios.get(url + '/' + transactionId, { params, headers })
            .then(function (response) {
                // Step 4: Parse the success response and process further
                console.log(JSON.stringify(response.data, null, 2))
            })
            .catch(function (error) {
                // Step 5: Parse the error response and handle the errors
                if (error.response) {
                    console.log('Response status:', error.response.status);
                    console.log('Response body:', error.response.data);
                } else {
                    // TODO: handle generic errors
                    console.error('Error:', error.message);
                }
            });
    } catch (error) {
        // TODO: handle exception
        console.error('Error:', error.message);
    }
};

status();
import requests
import uuid
import json

def status():

    # Step 1: Read configuration values with upmost security
    token = "your_access_token_from_oauth_response"
    # For production - api.moneygram.com & For test - sandboxapi.moneygram.com
    host = "sandboxapi.moneygram.com";
    url = 'https://' + host + '/disbursement/status/v1/transactions/lite';

    # Step 2: Create the GET request headers & params
    headers = {
        'Content-Type': 'application/json',
        'X-MG-ClientRequestId': str(uuid.uuid4()), # New UUID for each request tracing
        'Authorization': 'Bearer ' + token,
    }

    transactionId = "current_transaction_id";
    params = {
        'agentPartnerId': 'your_partner_id',    
        'userLanguage': 'en-US',
        'targetAudience': 'AGENT_FACING',
    }

    try:
        # Step 3: Send the request and obtain the response
        response = requests.get(url + '/' + transactionId, params=params, headers=headers)

        # Step 4: Parse the success response and process further
        if response.status_code == 200:
            parsed_response = json.dumps(json.loads(response.text), indent=2)
            print(parsed_response)
        else:
            # Print the error message if request fails
            # TODO: handle exception
            print("Request failed with status code:", response.status_code)
            print(json.loads(json.dumps(response.text, indent=4)))

    except requests.exceptions.RequestException as e:
        # Print any error that occurred during the request
        # TODO: handle exception
        print("An error occurred:", e)

status()

package status;

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.UUID;

public class StatusByTransactionID {

    public static void main(String[] args) {
        // Step 1: Read configuration values with upmost security
        String token = "your_access_token_from_oauth_response";

        // For production - api.moneygram.com & For test - sandboxapi.moneygram.com
        String host = "sandboxapi.moneygram.com";

        // Step 2: Create the GET request headers & params
        // Mandatory Query params
        String agentPartnerId = "your_partner_id";
        String userLanguage = "en-US";

        // Optional Query params
        String targetAudience = "AGENT_FACING";

        // Mandatory Path params
        String transactionId = "current_transaction_id";

        String uri = "https://" + host + "/disbursement/status/v1/transactions/lite/" + transactionId + "?"
                + "agentPartnerId=" + agentPartnerId
                + "&userLanguage=" + userLanguage
                + (targetAudience.isBlank() ? "" : "&targetAudience=" + targetAudience);

        HttpClient httpClient = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(uri))
                .GET()
                .setHeader("Authorization", "Bearer " + token)
                .setHeader("X-MG-ClientRequestId", String.valueOf(UUID.randomUUID()))
                .build();

        try {
            // Step 3: Send the request and obtain the response
            HttpResponse<String> response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());

            // Retrieve the status code and body from the response
            int statusCode = response.statusCode();

            // Step 4: Parse the success response and process further
            if (statusCode == 200) {
                String responseBody = response.body();
                System.out.println(responseBody);
            } else {
                // Step 5: Parse the error response and handle the errors
                String responseBody = response.body();
                System.out.println(responseBody);
            }
        } catch (Exception e) {
            e.printStackTrace();
            // TODO: handle exception
        }

    }
}



API Structure


Header Parameters

FieldTypeRequired
/Optional
Description
X-MG-ClientRequestIdStringOptionalClient Request ID that can be passed by the client application. Client request Id must be unique within a single session for unique requests. This attribute can be used for ensuring idempotent request processing for some APIs. MoneyGram recommends using a UUID for the value of this field.



Query Parameters

FieldTypeRequired
/Optional
Description
targetAudienceStringOptionalTailors MoneyGram’s error messages and field metadata to an in-store, digital or crypto consumer. (Enumerated value)

NOTE: For a full list of accepted target audience values. See the TARGET_AUDIENCE enumeration from the Reference Data Enumerations endpoint
userLanguageStringRequiredLanguage used by the user/operator
agentPartnerIdStringRequiredUnique agent or partner identifier



Path Parameters

FieldTypeRequired
/Optional
Description
transactionIdStringRequiredMoneyGram's reference number for the transaction or
Unique identifier for the transaction resource



Response Fields

FieldTypeRequired/
Optional
Description
transactionIdString
Max length: 36
OptionalUnique identifier for the transaction resource
partnerTransactionIdSTringOptionalPartners Unique identifier for the transaction resource
referenceNumberString
Max length: 8
OptionalMoneyGram's reference number for the transaction
transactionSendDateTimeString
$date-time
OptionalTransaction send date and time
transactionStatusStringOptionalMoneyGram's transaction status
transactionSubStatus.subStatusStringOptionalMoneyGram's transaction sub-status
transactionSubStatus.messageStringOptionalMessage associated with the sub-status code
transactionSubStatus.targetCustomerStringOptionalCustomer associated with sub-status code
transactionSubStatus.dataToCollect.codeStringOptionalUnique code for data or document needed to be collected from customer
transactionSubStatus.dataToCollect.datacollectionStringOptionalData or document needed to be collected from customer