Development Guide

'Retrieve Fields for a Transfer' endpoint retrieves all the required, and optional fields, and metadata for a send transaction based a service option, destination country, send amount, and send and receive currency.

1. Prepare headers & authentication:

Call the 'GET Retrieve Fields for a Transfer' endpoint with a POST HTTP method, providing the OAuth access_token in the header and all other required header values

Note: MoneyGram uses the OAuth 2.0 framework. The application must use their OAuth client credentials to generate an accessToken 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:
👉
Reference Data - Retrieve Fields for a Transfer - Headers
Open Recipe

2. Provide query parameters.

The application must provide the agentPartnerId, destinationCountry, serviceOptionCode, amount, sendCurrencyCode, receiveCurrencyCode as query parameters.

Note:

**ISO Standards: **The Retrieve All Send Transaction Fields API uses ISO Standards for country values. MoneyGram provide other Reference Data APIs which can be queried to understand and list the supported values and associated metadata. Learn More

serviceOptions: MoneyGram provide Reference Data APIs which can be queried to understand the supported service options per designation country. Learn More

🚀
Launch Code Example:
👉
Reference Data - Retrieve Fields for a Transfer - Query Parameters
Open Recipe

3. Make the request and handle the response:

The application will call the 'Retrieve Fields for a Transfer' endpoint with a GET HTTP method. The endpoint will return REQUIRED & OPTIONAL fields, with associated meta-data about the field. The application must build to handle the following response scenarios.

Success | Parse the Response | 200 OK HTTP Status
When the 'Retrieve Fields for a Transfer' endpoint responds with a 200 HTTP Status. An array of the REQUIRED & OPTIONAL fields are returned, with fieldInfo (i.e. meta-data) associated to the field.

Failed | Handle the Error | 400 Bad Request HTTP Status
When the 'Retrieve Fields for a Transfer' endpoint responds with 400 HTTP Status, specific error code/s will be returned with an array of offending fields.

Note: The Retrieve Fields for a Transfer API will return the following meta-data about a field: field , dataType, required, fieldLabel, displayOrder, fieldMin, fieldMax.

🚀
Launch Code Example:
👉
Reference Data - Retrieve Fields for a Transfer - 200 OK
Open Recipe
.
👉
Reference Data - Retrieve Fields for a Transfer - 400 Bad Request
Open Recipe

Code Examples

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

const transactionFieldsSend = 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 + '/reference-data/v1/transaction-fields-send';

    // 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 = {
        targetAudience: "AGENT_FACING",
        agentPartnerId: "your_partner_id",
        userLanguage: "en-US",
        destinationCountryCode: "USA",
        destinationCountrySubdivisionCode: "US-TX",
        serviceOptionCode: "WILL_CALL",
        amount: 100.00,
        sendCurrencyCode: "USD",
        receiveCurrencyCode: "USD"
    }

    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(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);
    }
};

transactionFieldsSend();

import requests
import uuid
import json

def transaction_fields_send():

    # 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 + '/reference-data/v1/transaction-fields-send';

    # 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 = {
        'targetAudience': 'AGENT_FACING',
        'agentPartnerId': 'your_partner_id',
        'userLanguage': 'en-US',
        'destinationCountryCode': "USA",
        'destinationCountrySubdivisionCode': "US-TX",
        'serviceOptionCode': "WILL_CALL",
        'amount': 100.00,
        'sendCurrencyCode': "USD",
        'receiveCurrencyCode': "USD"
    }

    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)

transaction_fields_send()

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

    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";
        String destinationCountryCode = "USA";
        String destinationCountrySubdivisionCode = "US-TX";
        String serviceOptionCode = "WILL_CALL";
        String amount = "100.00";
        String sendCurrencyCode = "USD";
        String receiveCurrencyCode = "USD";

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

        String uri = "https://" + host + "/reference-data/v1/transaction-fields-send?"
                + "agentPartnerId=" + agentPartnerId
                + "&userLanguage=" + userLanguage
                + "&destinationCountryCode=" + destinationCountryCode
                + "&destinationCountrySubdivisionCode=" + destinationCountrySubdivisionCode
                + "&serviceOptionCode=" + serviceOptionCode
                + "&amount=" + amount
                + "&sendCurrencyCode=" + sendCurrencyCode
                + "&receiveCurrencyCode=" + receiveCurrencyCode
                + (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 Request & Response Examples

curl --request GET \
     --url https://sandboxapi.moneygram.com/reference-data/v1/transaction-fields-send&targetAudience=AGENT_FACING&agentPartnerId=12345678&userLanguage=EN-US&destinationCountryCode=USA&serviceOptionCode=WILL_CALL&amount=100.00&sendCurrencycode=USD&receiveCurrencyCode=USD \
     --header 'X-MG-ClientRequestId: 4c79b06f-a2af-4859-82c8-28cbb0bf361b' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer ***************************' \
     --header 'content-type: application/json' \
     --data '

{
    "destinationCountryCode": "USA",
    "destinationCountrySubdivisionCode": "US-TX",
    "amount": 100.00,
    "sendCurrencyCode": "USD",
    "receiveCurrencyCode": "USD",
    "serviceOptionCode": "BANK_DEPOSIT",
    "serviceOptionName": "Bank Deposit - All Banks",
    "serviceOptionRoutingCode": "12345678",
    "serviceOptionRoutingName": "All Banks",
    "fieldInfo": [
        {
          "field": "sender.name.firstName",
          "dataType": "string",
          "required": true,
          "fieldLabel": "First Name",          
          "fieldMin": "0",
          "fieldMax": "20",
          "regEx":"^([a-zA-Z \\À-\\ſ\\\\-\\\\'\\/])*$"
        },
        {
          "field": "sender.name.lastName",
          "dataType": "string",
          "required": true, 
          "fieldLabel": "Last Name",          
          "fieldMin": "0",
          "fieldMax": "30",
          "regEx":"^([a-zA-Z \\À-\\ſ\\\\-\\\\'\\/])*$"
        },
        {
          "field": "sender.mobilePhone.countryDialCode",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Sender Phone Country Code",
          "fieldMax": "5"
        },
        {
          "field": "sender.mobilePhone.number",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Phone",           
          "fieldMin": "6",
          "fieldMax": "14",
          "regEx": "[0-9]*",
          "exampleText": "1234567890"
        },
        {
          "field": "receiver.name.firstName",
          "dataType": "string",
          "required": true,
          "fieldLabel": "First Name",           
          "fieldMin": "0",
          "fieldMax": "20",
          "regEx":"^([a-zA-Z \\À-\\ſ\\\\-\\\\'\\/])*$"
        },
        {
          "field": "receiver.name.middleName",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Middle Name",          
          "fieldMin": "0",
          "fieldMax": "20",
          "regEx":"^([a-zA-Z \\À-\\ſ\\\\-\\\\'\\/])*$"
        },
        {
          "field": "receiver.name.lastName",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Last Name",          
          "fieldMin": "0",
          "fieldMax": "30",
          "regEx":"^([a-zA-Z \\À-\\ſ\\\\-\\\\'\\/])*$"
        },
        {
          "field": "targetAccount.bankCode",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Routing Number",
          "displayOrder": "5",
          "fieldMin": "9",
          "fieldMax": "9",
          "regEx": "[0-9]*"
        },
        {
          "field": "targetAccount.accountType",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Account Type",
          "displayOrder": "7",
          "fieldMin": "1",
          "fieldMax": "10",
          "regEx": "[0-9A-Za-z]*",
          "enumerationItem": [
            {
              "value": "22",
              "description": "Checking"
            },
            {
              "value": "32",
              "description": "Saving"
            }
          ]
        },
        {
          "field": "targetAccount.accountNumber",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Account Number",
          "displayOrder": "8",
          "fieldMin": "4",
          "fieldMax": "17",
          "regEx": "[0-9]*"
        },
        {
          "field": "targetAccount.accountNumberVerification",
          "dataType": "string",
          "required": true,
          "fieldLabel": "Re-enter Account Number.",          
          "displayOrder": "9",
          "fieldMin": "4",
          "fieldMax": "17",
          "regEx": "[0-9]*"
        }
    ]
}

API Structure

Header Parameters

Field	Type	Required/ Optional	Description
`X-MG-ClientRequestId`	String	Required	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 this field value.

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 _
`agentPartnerId`	String String Max length: 8	Required	Unique agent or partner identifier
`userLanguage`	String Max length: 6	Required	Language used by the user/operator
`destinationCountryCode`	String Min length: 3 Max length: 3	Required	Transaction Destination Country (ISO alpha-3 code)
`destinationCountrySubdivisionCode`	String Max length: 6	Optional	Destination country state/province (ISO alpha-3 code)
`transactionId`	String Max length: 36	Optional	Unique identifier for the transaction resource
`serviceOptionCode`	String Max length: 21	Required	Unique category code to identify the transaction method
`serviceOptionRoutingCode`	String Max length: 21	Optional	Unique code to identify the individual transaction method
`amount`	String Min length: 0 Max length: 14 Max Decimal Value: 3	Required	Send amount of the the transaction
`sendCurrencyCode`	String Max length: 3	Required	Amount's currency code (ISO alpha-3 code)
`receiveCurrencyCode`	String Max length: 3	Required	Receive Currency is needed when transacting to a destination country that supports more than one currency. (ISO alpha-3 code)
`fundInStore`	Boolean	Optional	Flag to indicate transaction is to be funded in store within a 24hour period
`fundInStoreAgentPartnerId`	String Max length: 8	Optional	Unique store identifier where transaction will be funded
`targetAccountProfileId`	String	Optional	Unique Identifier for Target Account Resource

Response Fields

Field	Type	Required/ Optional	Description
`destinationCountryCode`	String	Optional	Transaction Destination Country (ISO alpha-3 code)
`destinationCountrySubdivisionCode`	String	Optional	Destination country's subdivision ISO alpha-3 code
`amount`	String	Required	Send amount of the the transaction
`sendCurrencyCode`	String	Required	Amount's currency code (ISO alpha-3 code)
`receiveCurrencyCode`	String	Required	Receive currency code (ISO alpha-3 code)
`serviceOptionCode`	String	Optional	Unique 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
`serviceOptionName`	String	Required	Consumer facing name to identify the transaction method NOTE: For a full list of accepted service option display names per destination country see the Reference Data API Module: service-options endpoint
`serviceOptionRoutingCode`	String	Optional	Unique code to identify the individual transaction method NOTE: For a full list of accepted service option routine codes per destination country see the Reference Data API Module: service-options endpoint