GET Retrieve a Transaction

GET /payout/v1/transactions/?referenceNumber={referenceNumber}

Development Guide

The 'Retrieve a Transaction' endpoints looks-up a transaction by referenceNumber and will return the transaction details and determine if it is available for payout.


1. Prepare headers, authentication & parameters:

The application must call the 'Retrieve a transaction' endpoint with a GET HTTP method, providing the OAuth access_token and all other required headers. The application must pass the transaction referenceNumber as a query parameter to retrieve the transaction.


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 Example Code:




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 | "availableForPayout": true
    When the 'Retrieve a transaction' by referenceNumber endpoint responds with a 200 HTTP Status the response will typically return the transactionId, payoutId, sender, receiver and transactionInformation fields.

  • Failed | Parse the Response | 200 OK HTTP Status | "availableForPayout": false
    When the 'Retrieve a transaction' by referenceNumber endpoint responds with a 200 HTTP Status but the "availableForPayout": false, the transaction cannot be paid out. This is because the transactionStatus is not available for payout. Learn More.

  • 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.

🚀

Launch Example Code:

.

.




3. Communicate the transaction status to customer:

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




4. You're Done! Proceed to Update a Transaction API:

The application must execute the 'Update a transaction' endpoint to get the readyForCommit": true.


Note:

  • To execute the refund, the transactionId returned in the payload must be persisted and used as a path parameter on subsequent 'Update a Transaction' API.
  • To execute the refund, the payoutId returned in the payload must be persisted and used as in the request body of the subsequent 'Update a Transaction' API.




Business Rules to Code:


🔎

  • Ready for Payout & Available status: The transaction can only be paid out if the transaction is in an AVAILABLE status and the "availableForPayout": true is returned in the response.
  • Send & Payout at the same store: A Payout cannot be received at the same store location where the transaction was sent (i.e. The application cannot Payout a transaction using the same partnerAgentId that was used to send the transfer).


Code Examples


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

    // Step 2: Create the GET 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
                // Verify readyForCommit is true, if yes, transaction is ready to commit
                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);
    }
};

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 + '/payout/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:
            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)

retrieve()

package payout;

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

    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 + "/payout/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 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.
X-MG-ConsumerIPAddressStringOptionalIP address of the system initiating the session.



Query parameters

FieldTypeRequired/
Optional
Description
targetAudienceStringOptionalTailors 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
userLanguageStringRequiredLanguage used by the user/operator
agentPartnerIdStringRequiredUnique agent or partner identifier
referenceNumberStringRequiredMoneyGram's reference number for the transaction
posIdStringOptionalPoint of sale identifier of the client performing the API Call
operatorIdStringOptionalOperator 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.



Response fields

FieldTypeRequired/
Optional
Description
transactionIdString
Max length: 36
OptionalUnique identifier for the transaction resource
payoutIdStringOptionalUnique identifier for the transaction session
availableForPayoutBooleanOptionalIdentifies if the transaction is in a status available for payout
transactionStatusStringOptionalMoneyGram's transaction status
transactionSubStatus.subStatusStringOptionalMoneyGram's transaction sub-status
transactionSubStatus.targetCustomerStringOptionalCustomer associated with sub-status code.
transactionSubStatus.customerActionStringOptionalMessage associated with the sub-status code.
transactionSubStatus.dataToCollect.codeStringOptionalUnique code to identify the data or document to collect
transactionSubStatus.dataToCollect.dataCollectionStringOptionalData or document needed to be collected from customer
originatingCountryCodeString
Max Length: 3
OptionalTransaction country of origin (ISO alpha-3 code)

NOTE: For a full list of accepted originating country ISO codes see the Reference data API module: Retrieve countries ISO3 endpoint
destinationCountryCodeString
Max Length: 3
OptionalTransaction destination country (ISO alpha-3 code)

NOTE: For a full list of accepted destination countries and supported destination country subdivision codes see Reference data API module: Retrieve countries ISO3 endpoint
serviceOptionCodeString
Max length: 21
RequiredUnique category code to identify the transaction method

NOTE: For a full list of accepted service option codes per destination country see the Reference data API module: service-options endpoint
serviceOptionNameString
Max length: 50
OptionalUnique name to identify the transaction method

NOTE: For a full list of accepted service option names per destination country see the Reference data API module: service-options endpoint
serviceOptionRoutingCodeString
Max length: 21
RequiredUnique 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 the Reference data API module: service-options endpoint
sendAmount.amount.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredTransaction 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.currencyCodeStringRequiredThe sendAmount.amount.value currency code (ISO alpha-3 code)
sendAmount.fees.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredFee amount and fee currency applied to transaction (Fee currency usesISO alpha-3 code)
sendAmount.fees.currencyCodeStringRequiredThe sendAmount.fees.value currency code (ISO alpha-3 code)
sendAmount.taxes.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalTax amount and tax currency applied to the transaction by the the origin country (Tax currency uses ISO alpha-3 code)
sendAmount.taxes.currencyCodeStringOptionalThe sendAmount.taxes.value currency code (ISO alpha-3 code)
sendAmount.discountsApplied.totalDiscountString
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalTransaction discount amount applied and currency type excluding fees and exchange rate. Transaction currency (ISO alpha-3 code)
sendAmount.discountsApplied.promotionDetailsString
String
Max length: 50
OptionalAdditional details about the applied promotion to the transaction
sendAmount.total.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredTransaction total amount and transaction total currency including fees, taxes and discount. (Transaction total amount uses ISO alpha-3 code)
sendAmount.total.currencyCodeStringRequiredThe sendAmount.total.value currency code (ISO alpha-3 code)
receiveAmount.amount.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredTransaction received amount and transaction receive currency (Transaction total amount uses ISO alpha-3 code)
receiveAmount.amount.currencyCodeStringRequiredThe receiveAmount.amount.value currency code (ISO alpha-3 code)
receiveAmount.fees.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalReceived fee and receive currency applied to the transaction by the destination country (Transaction total amount uses ISO alpha-3 code)
receiveAmount.fees.currencyCodeStringOptionalThe receiveAmount.fees.value currency code (ISO alpha-3 code)
receiveAmount.taxes.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalTax amount and tax currency applied to the transaction by the the origin country (Tax currency uses ISO alpha-3 code)
receiveAmount.taxes.currencyCodeStringOptionalThe receiveAmount.taxes.value currency code (ISO alpha-3 code)
receiveAmount.total.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredReceive 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.currencyCodeStringRequiredThe receiveAmount.total.value currency code (ISO alpha-3 code)
receiveAmount.fxRateNumber
Max Decimal Value: 6
RequiredFX rate applied to transaction
receiveAmount.fxRateEstimatedBooleanOptionalIndicates 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.
originalReceiveAmount.amount.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredTransaction received amount and transaction receive currency (Transaction total amount uses ISO alpha-3 code)
originalReceiveAmount.amount.currencyCodeStringRequiredThe orginalReceiveAmount.amount.value currency code (ISO alpha-3 code)
originalReceiveAmount.fees.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalReceived fee and receive currency applied to the transaction by the destination country (Transaction total amount uses ISO alpha-3 code)
originalReceiveAmount.fees.currencyCodeStringOptionalThe orginalReceiveAmount.fees.value currency code (ISO alpha-3 code)
receiveAmount.taxes.value String
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalTax amount and tax currency applied to the transaction by the the origin country (Tax currency uses ISO alpha-3 code)
receiveAmount.taxes.currencyCodeStringOptional
originalReceiveAmount.total.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredReceive 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)
originalReceiveAmount.total.currencyCodeStringRequiredThe orginalReceiveAmount.total.value currency code (ISO alpha-3 code)
originalReceiveAmount.fxRateNumber
Max Decimal Value: 6
RequiredFX rate applied to transaction
originalReceiveAmount.fxRateEstimatedBooleanOptionalIndicates 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.
estimatedReceiveAmountInLocalCurrency.amountString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredTransaction received amount and transaction receive currency (Transaction total amount uses ISO alpha-3 code)
estimatedReceiveAmountInLocalCurrency.currencyCodeStringRequiredThe estimatedReceiveAmountInLocalCurrency.amount.value currency code (ISO alpha-3 code)
estimatedReceiveAmountInLocalCurrency.fees.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalReceived fee and receive currency applied to the transaction by the destination country (Transaction total amount uses ISO alpha-3 code)
estimatedReceiveAmountInLocalCurrency.fees.currencyCodeStringOptionalThe estimatedReceiveAmountInLocalCurrency.fees.value currency code (ISO alpha-3 code)
estimatedReceiveAmountInLocalCurrency.taxes.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
OptionalTax amount and tax currency applied to the transaction by the the origin country
estimatedReceiveAmountInLocalCurrency.taxes.currencyCodeStringOptionalThe estimatedReceiveAmountInLocalCurrency.taxes.value currency code (ISO alpha-3 code)
estimatedReceiveAmountInLocalCurrency.total.valueString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredReceive amount total and receive transaction currency to be pickef up/deposited in destination country including fees, taxes and discount (Transaction total amount uses ISO alpha-3 code)
estimatedReceiveAmountInLocalCurrency.total.currencyCodeStringRequiredThe estimatedReceiveAmountInLocalCurrency.total.value currency code (ISO alpha-3 code)
estimatedReceiveAmountInLocalCurrency.fxRateNumber
Max Decimal Value: 6
RequiredFX rate applied to transaction
estimatedReceiveAmountInLocalCurrency.fxRateEstimatedBooleanOptionalIndicates 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.firstNameString
Min length: 1
Max length: 20
RequiredFirst name
sender.name.middleNameString
Min length: 1
Max length: 20
OptionalMiddle name (if applicable)
sender.name.lastNameString
Min length: 1
Max length: 30
OptionalLast name
sender.name.secondLastNameString
Min length: 1
Max length: 30
OptionalSecond last name
receiver.name.firstNameString
Min length: 1
Max length: 20
RequiredFirst name
receiver.name.middleNameString
Min length: 1
Max length: 20
OptionalMiddle name (if applicable)
receiver.name.lastNameString
Min length: 1
Max length: 30
OptionalLast name
receiver.name.secondLastNameString
Min length: 1
Max length: 30
OptionalSecond last name (if applicable)
additionalDetailsDynamicOptionalDynamic field key/values