Development Guide

The 'Retrieve a Transaction' endpoints look-up and return a transaction by referenceNumber or transactionId for the purpose of a amending a transaction.

1. Prepare headers, authentication & parameters:

The application must call the Retrieve a Transaction by Reference Number or by Transaction ID endpoint with a GET HTTP method, providing the OAuth access_token , required header values and parameters.

There are two endpoints that can be used to lookup and retrieve a transaction for an amend:

Retrieve a transaction by transactionId resource | GET /amend/v1/transactions/{transactionId}

OR
Retrieve a transaction by referenceNumber | GET /amend/v1/transactions/?referenceNumber={referenceNumber}

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:
👉
Amend - Retrieve by Transaction ID - Headers
Open Recipe
.
👉
Amend - Retrieve by Reference Number - Headers
Open Recipe

2. Make a request and handle the response:

The application must call 'Retrieve a transaction' 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' by transactionId or referenceNumber endpoint responds with a 200 HTTP Status the response will typically return the transactionId, amendId, sender, receiver and transactionInformation fields.
Failed | Handle the Error | 400 Bad Request HTTP Status
When the 'Retrieve a transaction' endpoint responds with 400 HTTP Status, specific error code/s will be returned with an array of offending fields. The application will need to resolve these errors and resubmit the request.

Note:

The amendId returned in the response is required by the 'Modify receiver name' or the 'Modify receiver additional data' endpoint and must be stored and passed to it.

The transaction cannot be amended if the "availableForAmend": False is returned in the response payload.

The Retrieve API provides only status information regarding a transaction's potential to be amended. It does not return the transaction status. For complete transaction status details, please refer to the Status API

🚀
Launch Code Example:
.
👉
Amend - Retrieve by Reference Number - 200 OK
Open Recipe
.
👉
Amend - Retrieve by Reference Number - 400 Bad Request
Open Recipe

3. Communicate the transaction summary:

The information returned can be used to display a Transaction Summary feature on the application UI.

4. You're Done! Proceed to the Modify Receiver Name or Modify Receiver Additional Data:

The application can now amend the Receiver's name using the Update Receiver Name endpoint or amend the transactional information using the Update Receiver Additional Data endpoint.

Note:

To execute the amend, the transactionId returned in the payload must be persisted and used as a path parameter on the subsequent 'Modify Receiver Name' or 'Modify Receiver Additional Details' endpoints.

To execute the amend, the amendId returned in the payload must be persisted and used as in the request body of the subsequent 'Modify Receiver Name' or 'Modify Receiver Additional Details' endpoints.

Business Rules to Code

🔎
Condition to allow an amend

To Modify the Receiver's Name: The transaction must be in an "AVAILABLE" status.

To Modify receiver additional data: The transaction must be an "PROCESSING" status.

Status: The Retrieve API provides only status information regarding a transaction's potential to be amended. It does not return the transaction status. For complete transaction status details, please refer to the Status API

Code Examples

Retrieve a transaction by `transactionId`

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

const retrieve = 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 + '/amend/v1/transactions';

    // 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("ResponseHeaders\n" + response.headers)
                console.log("ResponseBody\n" + 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);
    }
};

retrieve();

import requests
import uuid
import json

def retrieve():

    # 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 + '/amend/v1/transactions';

    # 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:
            print("ResponseHeaders")
            print(response.headers)
            parsed_response = json.dumps(json.loads(response.text), indent=2)
            print("ResponseBody")
            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)

retrieve()

package amend;

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 RetrieveByTransactionID {

    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 + "/amend/v1/transactions/" + 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 responseHeaders = String.valueOf(response.headers());
                System.out.println("ResponseHeaders\n" + responseHeaders);
                String responseBody = response.body();
                System.out.println("ResponseBody\n" + 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
        }

    }
}

Retrieve a transaction by `referenceNumber`

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

const retrieve = 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 + '/amend/v1/transactions';

    // 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 params = {
        agentPartnerId: "your_partner_id",
        referenceNumber: "your_reference_number",
        userLanguage: "en-US",
        targetAudience: "AGENT_FACING"
    }

    try {
        // Step 3: Send the request and obtain the response
        axios.get(url, { params, headers })
            .then(function (response) {
                // Step 4: Parse the success response and process further
                console.log("ResponseHeaders\n" + response.headers)
                console.log("ResponseBody\n" + 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);
    }
};

retrieve();

import requests
import uuid
import json

def retrieve():

    # 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 + '/amend/v1/transactions';

    # 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,
    }

    params = {
        'agentPartnerId': 'your_partner_id',
        'referenceNumber': 'your_reference_number',
        'userLanguage': 'en-US',
        'targetAudience': 'AGENT_FACING',
    }

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

        # Step 4: Parse the success response and process further
        if response.status_code == 200:
            print("ResponseHeaders")
            print(response.headers)
            parsed_response = json.dumps(json.loads(response.text), indent=2)
            print("ResponseBody")
            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)

retrieve()

package amend;

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 RetrieveByReferenceNumber {

    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 referenceNumber = "your_reference_number";
        String userLanguage = "en-US";

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

        String uri = "https://" + host + "/amend/v1/transactions?"
                + "agentPartnerId=" + agentPartnerId
                + "&referenceNumber=" + referenceNumber
                + "&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 responseHeaders = String.valueOf(response.headers());
                System.out.println("ResponseHeaders\n" + responseHeaders);
                String responseBody = response.body();
                System.out.println("ResponseBody\n" + 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

Field	Type	Required /Optional	Description
`X-MG-ClientRequestId`	String	Optional	Client 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.
`X-MG-ConsumerIPAddress`	String	Optional	IP Address of the system initiating the session

Query Parameters

Field	Type	Required /Optional	Description
`targetAudience`	String	Optional	Tailors MoneyGram’s error messages and field metadata to an in-store, digital or crypto customer. (Enumerated value) NOTE: For a full list of accepted target audience values. See the TARGET_AUDIENCE enumeration from the Reference Data Enumerations endpoint
`userLanguage`	String Max length: 6	Required	Language used by the user/operator
`agentPartnerId`	String Max length: 8	Required	Unique agent or partner identifier
`payoutId`	String	Optional	Point of sale identifier of the client performing the API Call
`operatorId`	String	Optional	Operator name or ID of the user performing the transaction. Name or ID must be populated from the agent/partner system and cannot be edited by the user.
`referenceNumber`	String Max length: 8	Required	MoneyGram's reference number for the transaction NOTE: Used only when retrieving a transaction by referenceNumber

Path Parameters

Field	Type	Required /Optional	Description
`transactionId`	String Max length: 36	Required	Unique id of the transaction resource NOTE: Used only when retrieving a transaction by transactionId

Response Fields

Field	Type	Required/ Optional	Description
`transactionId`	String Max length: 36	Optional	Unique identifier for the transaction resource
`amendId`	String	Required	Unique identifier for the transaction session
`transactionStatus`	String	Optional	MoneyGram's transaction status
`transactionSubStatus.subStatus`	String	Optional	Latest sub-status of transaction
`transactionSubStatus.message`	String	Optional	Message associated with the sub-status code.
`transactionSubStatus.targetCustomer`	String	Optional	Customer associated with sub-status code
`transactionSubStatus.dataToCollect.code`	String	Optional	Unique code to identify the data or document to collect
`transactionSubStatus.dataToCollect.dataCollection`	String	Optional	Data or document needed to be collected from customer
`availableForAmend`	Boolean	Optional	Flag to indicate the transaction is available for amend
`originatingCountryCode`	String Max Length: 3	Optional	Transaction country of Origin (ISO alpha-3 code) NOTE: For a full list of accepted originating country ISO codes see Reference Data API Module: countries/{iso3Code} endpoint
`destinationCountryCode`	String Max Length: 3	Optional	Transaction Destination Country (ISO alpha-3 code) NOTE: For a full list of accepted destination country ISO codes see Reference Data API Module: countries/{iso3Code} endpoint
`serviceOptionCode`	String Max length: 21	Required	Unique category code to identify the transaction method NOTE: For a full list of accepted service option codes per destination country see Reference Data API Module: Retrieve Service Options endpoint_
`serviceOptionName`	String Max length: 50	Optional	Unique name to identify the transaction method NOTE: For a full list of accepted service option names per destination country see Reference Data API Module: Retrieve Service Options endpoint_
`serviceOptionRoutingCode`	String Max length: 21	Optional	Unique identifier of the individual banking, wallet, or card provider for the service option. NOTE: For a full list of accepted service option routing codes per destination country see Reference Data API Module: Retrieve Service Options endpoint_
`serviceOptionRoutingName`	String Max length: 50	Optional	Unique name to identify the individual transaction method
`sendAmount.amount.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Required	Transaction amount and currency excluding fees and exchange rate. Transaction Currency (ISO alpha-3 code) NOTE: For Crypto partners this is the fiat currency for the BUY/Sell or Ramp-on/Ramp-off
`sendAmount.amount.currencyCode`	String	Required	The `sendAmount.amount.value` currency code (ISO alpha-3 code)
`sendAmount.fees.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Required	Fee Amount and Fee Currency applied to transaction (Fee Currency usesISO alpha-3 code)
`sendAmount.fees.currencyCode`	String	Required	The `sendAmount.fees.value` currency code (ISO alpha-3 code)
`sendAmount.taxes.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Optional	Tax Amount and Tax Currency applied to the Transaction by the the origin country (Tax Currency uses ISO alpha-3 code)
`sendAmount.taxes.currencyCode`	String	Optional	The `sendAmount.taxes.value` currency code (ISO alpha-3 code)
`sendAmount.discountsApplied.totalDiscount`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Optional	Transaction discount amount applied and currency type excluding fees and exchange rate. Transaction Currency (ISO alpha-3 code)
`sendAmount.discountsApplied.promotionDetails`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Optional	Additional Details about the applied promotion to the transaction
`sendAmount.total.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Required	Transaction Total Amount and Transaction Total Currency including fees, taxes and discount. (Transaction Total Amount uses ISO alpha-3 code)
`sendAmount.total.currencyCode`	String	Required	The `sendAmount.total.value` currency code (ISO alpha-3 code)
`receiveAmount.amount.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Required	Transaction Received Amount and Transaction Receive currency (Transaction Total Amount uses ISO alpha-3 code)
`receiveAmount.amount.currencyCode`	String	Required	The `receiveAmount.amount.value` currency code (ISO alpha-3 code)
`receiveAmount.fees.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Optional	Received Fee and Receive Currency applied to the transaction by the destination country (Transaction Total Amount uses ISO alpha-3 code)
`receiveAmount.fees.currencyCode`	String	Optional	The `receiveAmount.fees.value` currency code (ISO alpha-3 code)
`receiveAmount.taxes.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Optional	Tax Amount and Tax Currency applied to the Transaction by the the origin country (Tax Currency uses ISO alpha-3 code)
`receiveAmount.taxes.currencyCode`	String	Optional	The `receiveAmount.taxes.value` currency code (ISO alpha-3 code)
`receiveAmount.total.value`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Required	Receive Amount Total and Receive Transaction Currency to be picked-up/deposited in destination country including fees, taxes and discount (Transaction Total Amount uses ISO alpha-3 code)
`receiveAmount.total.currencyCode`	String	Required	The `receiveAmount.total.value` currency code (ISO alpha-3 code)
`receiveAmount.fxRate`	Number Max Decimal Value: 6	Required	Fx Rate applied to transaction
`sendAmount.fxRateEstimated`	Boolean	Optional	Indicates whether the Fx is “estimated” and amount, taxes and total cannot be guaranteed. The word “estimated” must appear before receiveAmount.amount, receiveAmount.taxes and receiveAmount.total only when true.
`sender.name.firstName`	String Min length: 1 Max length: 20	Required	First Name
`sender.name.middleName`	String Min length: 1 Max length: 20	Optional	Middle Name (if applicable)
`sender.name.lastName`	String Min length: 1 Max length: 30	Required	Last Name
`sender.name.secondLastName`	String Min length: 1 Max length: 30	Optional	Second Last Name (if applicable)
`sender.profileId`	String Min length: 1 Max length: 50	Optional	Unique Identifier of the consumer.
`sender.additionalDetails`	Dynamic	Optional	Dynamic field key/values
`receiver.name.firstName`	String Min length: 1 Max length: 20	Required	First Name
`receiver.name.middleName`	String Min length: 1 Max length: 20	Optional	Middle Name (if applicable)
`receiver.name.lastName`	String Min length: 1 Max length: 30	Required	Last Name
`receiver.name.secondLastName`	String Min length: 1 Max length: 30	Optional	Second last name (if applicable)
`additionalDetails`	Dynamic	Optional	Dynamic field key/values

GET Retrieve a Transaction

Development Guide

1. Prepare headers, authentication & parameters:

🚀
Launch Code Example:

2. Make a request and handle the response:

🚀
Launch Code Example:

3. Communicate the transaction summary:

4. You're Done! Proceed to the Modify Receiver Name or Modify Receiver Additional Data:

Business Rules to Code

🔎
Condition to allow an amend

Code Examples

Retrieve a transaction by `transactionId`

Retrieve a transaction by `referenceNumber`

API Structure

Header Parameters

Query Parameters

Path Parameters

Response Fields

Development Guide

1. Prepare headers, authentication & parameters:

🚀Launch Code Example:

2. Make a request and handle the response:

🚀Launch Code Example:

3. Communicate the transaction summary:

4. You're Done! Proceed to the Modify Receiver Name or Modify Receiver Additional Data:

Business Rules to Code

🔎Condition to allow an amend

Code Examples

Retrieve a transaction by transactionId

Retrieve a transaction by referenceNumber

API Structure

Header Parameters

Query Parameters

Path Parameters

Response Fields

🚀
Launch Code Example:

🚀
Launch Code Example:

🔎
Condition to allow an amend

Retrieve a transaction by `transactionId`

Retrieve a transaction by `referenceNumber`