GET Retrieve Rates
'GET /fx-rate/v1/rates'
Development Guide:
The FX Rate endpoint will retrieve the most competitive foreign exchange rates for a given destination country and service option.
1. Prepare headers & authentication:
Call the 'Retrieve FX Rates' 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:
👉Retrieve FX Rates - HeadersOpen Recipe
2. Provide agentPartnerId
, originatingCountryCode
, destinationCountryCode
&sendCurrencyCode
as query parameters:
agentPartnerId
, originatingCountryCode
, destinationCountryCode
&sendCurrencyCode
as query parameters:The application must use a agentPartnerId
, originatingCountryCode
, destinationCountryCode
and sendCurrencyCode
as query parameter to retrieve the rate.
Launch Code Example:
👉Retrieve FX Rates - Query ParametersOpen Recipe
3. Make the request and handle the response:
The application must call 'Retrieve FX Rates' endpoint with a GET HTTP method. The Rates API will respond with a HTTP 200 OK Status and an array of fxRates
for each service options to the destination country.
- Success | Parse the Response | 200 OK HTTP Status
An array offxRates
will be returned will be the latest and most competitive Foreign Exchange Rate for the destination country. An array offxRates
will be returnedserviceOptionCode
,serviceOptionName
,serviceOptionRoutingCode
,sendCurrencyCode
,reiceveCurrencyCode
,fxRate
andfxRateEstimated
- Failed | Handle the Error | 400 Bad Request HTTP Status
When the 'Retrieve FX Rates' 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 Code Example:
👉Retrieve FX Rates - 200 OKOpen Recipe.
👉Status - 400 Bad RequestOpen Recipe
4. You're done! Communicate the fxRate
, "fxRateEstimated": true
and disclaimers to the customer
fxRate
, "fxRateEstimated": true
and disclaimers to the customerThe "fxRateEstimated": true
boolean indicated that the fxRate returned is only an estimate, it is not guaranteed. The application must indicate "Estimated Fx Rate" in the field label and and place disclaimers in the UI. Learn More
Note: The Fx Rate that is returned is not a formal quote, it is only estimation and cannot be used on the transfer of funds. The quote a transaction endpoint must be used on a transfer of funds, to provide generate a full quote and disclose all associated fee's, Fx, taxes, promotional discounts and totals.
Business Rules to Code:
UI Disclaimers: The Fx Rate that is returned is not a formal quote, it is only estimation and cannot be used on the transfer of funds. The application must indicate "Estimated Fx Rate" in the field label and and place disclaimers in the UI. Learn More
agentPartnerId: The
agentPartnerId
is provided as a query parameter to return the most competitive pricing specific for your business.
Code Examples
const axios = require('axios');
const { v4: uuidv4 } = require('uuid');
const fxRate = 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 + '/fx-rate/v1/rates';
// 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",
originatingCountryCode: "USA",
destinationCountryCode: "USA",
sendCurrencyCode: "USD",
userLanguage: "en-US",
serviceOptionCode: "",
receiveCurrencyCode: "",
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(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);
}
};
fxRate();
import requests
import uuid
import json
def fx_rate():
# 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 + '/fx-rate/v1/rates';
# 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',
'originatingCountryCode': 'USA',
'destinationCountryCode': 'USA',
'sendCurrencyCode': 'USD',
'userLanguage': 'en-US',
'serviceOptionCode': '',
'receiveCurrencyCode': '',
'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)
fx_rate()
package fx_rate;
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 FxRate {
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 originatingCountryCode = "USA";
String destinationCountryCode = "USA";
String sendCurrencyCode = "USD";
String userLanguage = "en-US";
// Optional Query params
String serviceOptionCode = "";
String receiveCurrencyCode = "";
String targetAudience = "AGENT_FACING";
String uri = "https://" + host + "/fx-rate/v1/rates?"
+ "agentPartnerId=" + agentPartnerId
+ "&originatingCountryCode=" + originatingCountryCode
+ "&destinationCountryCode=" + destinationCountryCode
+ "&sendCurrencyCode=" + sendCurrencyCode
+ "&userLanguage=" + userLanguage
+ (serviceOptionCode.isBlank() ? "" : "&serviceOptionCode=" + serviceOptionCode)
+ (receiveCurrencyCode.isBlank() ? "" : "&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
}
}
}
Support APIs
Name | HTTP Method | Endpoints | Description |
---|---|---|---|
Retrieve Countries | GET | /reference-data/v1/Country | Retrieves supported values and metadata for countries |
Retrieve Countries ISO3 | GET | /reference-data/v1 /countries/{iso3Code} | Retrieves supported values and metadata for countries by ISO 3 Code |
Retrieve Currencies | GET | /reference-data/v1/currencies | Retrieves supported values and metadata for currencies |
Retrieve Service Options | GET | /reference-data/v1/payout-options | Retrieves supported values and metadata for Service Options |
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. |
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 | Required | Language used by the user/operator |
agentPartnerId | String Max Length: 8 | Required | Unique agent or partner identifier |
originatingCountryCode | String Min length: 3 Max length: 3 | Required | Transaction 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 |
destinationCountryCode | String Min length: 3 Max length: 3 | Required | Transaction Destination Country (ISO alpha-3 code) _NOTE: For a full list of accepted destination countries and supported destination country subdivision ISO codes see the Reference Data API Module: Retrieve Countries ISO3 endpoint_ |
serviceOptionCode | String Max length: 21 | 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 |
sendCurrencyCode | String Max length: 3 | Required | Transaction send currency code (ISO alpha-3 code) |
receiveCurrencyCode | String Max length: 3 | Optional | Transaction destination currency code (ISO alpha-3 code) |
Response Fields
Field | Type | Required/ Optional | Description |
---|---|---|---|
serviceOptionCode | String Max length: 21 | 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: Retrieve Service Options endpoint |
serviceOptionName | String Max length: 40 | Optional | Unique name to identify the transaction method _NOTE: For a full list of accepted service option names per destinationCountry see the Reference Data API Module: Retrieve Service Options endpoint_ |
serviceOptionRoutingCode | String Max length: 8 | 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 the Reference Data API Module: Retrieve Service Options endpoint_ |
sendCurrencyCode | String Max length: 3 | Optional | Transaction send currency code (ISO alpha-3 code) |
receiveCurrencyCode | String Max length: 3 | Optional | Transaction Destination currency code (ISO alpha-3 code) |
fxRate | Number Max decimal value: 6 | Optional | Fx Rate applied to transaction |
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. |
Updated 18 days ago