GET Retrieve Fields for a Payout

GET /reference-data/v1/transaction-fields-receive

Development Guide

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


1. Prepare headers & authentication:

Call the 'GET Retrieve Fields for a Payout' endpoint with a Get 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:




2. Provide query parameters.

The application must provide the agentPartnerId, userLanguage', amount, 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:




3. Make the request and handle the response:

The application will call the 'Retrieve Fields for a Payout' 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 Payout' 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 Payout' 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 Payout API will return the following meta-data about a field: field , dataType, required, fieldLabel, displayOrder, fieldMin, fieldMax.


🚀

Launch Code Example:

.




Code Examples


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

const transactionFieldsReceive = 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-receive';

    // 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",
        amount: 100.00,
        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);
    }
};

transactionFieldsReceive();

import requests
import uuid
import json

def transaction_fields_receive():

    # 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-receive';

    # 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',
        'amount': 100.00,
        '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_receive()
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 TransactionFieldsReceive {

    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 amount: 100.00;
        String receiveCurrencyCode: "USD";

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

        String uri = "https://" + host + "/reference-data/v1/transaction-fields-receive?"
                + "agentPartnerId=" + agentPartnerId
                + "&userLanguage=" + userLanguage
                + "&amount" + amount
                + "&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 Structure


Header Parameters

FieldTypeRequired/
Optional
Description
X-MG-ClientRequestIdStringRequiredClient 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

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
agentPartnerIdString
String
Max length: 8
RequiredUnique agent or partner identifier
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.
userLanguageString
Max length: 6
RequiredLanguage used by the user/operator
transactionIdString
Max length: 36
OptionalUnique identifier for the transaction resource
referenceNumberStringOptionalMoneyGram's reference number for the transaction
amountString
Min length: 0
Max length: 14
Max Decimal Value: 3
RequiredSend amount of the the transaction
receiveCurrencyCodeString
Max length: 3
RequiredReceive Currency is needed when transacting to a destination country that supports more than one currency. (ISO alpha-3 code)
fundInStoreBooleanOptionalFlag to indicate transaction is to be funded in store within a 24hour period
fundInStoreAgentPartnerIdString
Max length: 8
OptionalUnique store identifier where transaction will be funded



Response Fields


FieldName/MetadataDescriptionExample Value
fieldInfo.fieldField name described in dot notationsender.name.firstName
fieldInfo.dataTypeData type of the fieldstring, boolean, number
fieldInfo.requiredFlag to Indicate if the field is required or optionaltrue
fieldInfo.fieldLabelUser facing label for the field for use on the UI. Can be overwritten if required.First name
fieldInfo.displayOrderUI recommended display order for the field."3"

NOTE: The response may return one or more targetAccount fields for a service-option. The displayOrder will be listed in the recommended order they should be displayed on the UI.
fieldInfo.fieldMinMin field field length"0"
fieldInfo.fieldMaxMax field field length"255"
fieldInfo.regExRegular expression for data validation of the field."^([a-zA-Z \À-\ſ\-\'/])*$"
fieldInfo.exampleTextExample field valueFirst name
fieldInfo.enumerationItemAn array of accepted values for the field.[ {
"value": "22",
"description": "Checking"
},
{
"value": "32",
"description": "Saving"
} ]