GET Retrieve a List of Businesses
GET /business/v1/profiles
Development Guide
The 'Retrieve a List of Businesses' endpoint will return an array of businessSender
associated with a agentPartnerId
.
1. Prepare headers & authentication:
The application must call the Retrieve a List of Business Profiles 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 Example Code
👉Profiles - Retrieve Transaction History - HeadersOpen Recipe
2. Provide agentpartnerId
as a query parameter:
agentpartnerId
as a query parameter:The application must provide the agentPartnerID
as a query parameter.
Launch Example Code
👉Business Profiles - Retrieve a Business Profile - businessProfileIDOpen Recipe
3. Make the request and handle the response:
The application will call the 'Retrieve a List of Business Profiles' endpoint with a GET HTTP method. The 'Retrieve Transaction History' will generate a response with the consumer name
details and an array of the consumer's transaction history for the date range provided. The application must build to handle the following response scenarios.
- Success | Parse the Response | 200 OK HTTP Status
When the 'Retrieve a List of Business Profiles' endpoint responds with a 200 HTTP Status. An array of the businesses affiliated to theagentPartnerId
will be returned. Profile details about each business will be returned.
- Success | Retrieve a List of Business Profiles has no content | 204 No Content HTTP Status
When the 'Retrieve a List of Business Profiles' endpoint responds with 204 HTTP Status. The 'Retrieve a List of Business Profiles' endpoint API will return a message of "The resource content not found".
- Failed | Retrieve a List of Business Profiles | 400 Bad Request HTTP Status
When the 'Retrieve a List of Business Profiles' 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 transaction for reversal.
Launch Example Code
👉Business Profiles - Retrieve a List of Business Profiles - 200 OKOpen Recipe.
👉Business Profiles - Retrieve a List of Business Profiles - 204 No ContentOpen Recipe.
👉Business Profiles - Retrieve a List of Business Profiles - 400 Bad RequestOpen Recipe
Code Examples
const axios = require('axios');
const { v4: uuidv4 } = require('uuid');
const listBusinessProfiles = 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 + '/business/v1/profiles';
// 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",
userLanguage: "en-US",
agentPartnerId: "your_partner_id",
pageNumber: "1",
perPage: "20"
}
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);
}
};
listBusinessProfiles();
import requests
import uuid
import json
def list_business_profiles():
# 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 + '/business/v1/profiles';
# Step 2: Create the GET request headers & body
headers = {
'Content-Type': 'application/json',
'X-MG-ClientRequestId': str(uuid.uuid4()), # New UUID for each request tracing
'Authorization': 'Bearer ' + token,
}
params = {
'targetAudience': 'AGENT_FACING',
'userLanguage': 'en-US',
'agentPartnerId': 'your_partner_id',
'pageNumber': '1',
'perPage': '20'
}
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:
# Step 5: Parse the error response and handle the errors
print("Request failed with status code:", response.status_code)
print(json.dumps(json.loads(response.text), indent=2))
except requests.exceptions.RequestException as e:
# Print any error that occurred during the request
# TODO: handle exception
print("An error occurred:", e)
list_business_profiles()
package businessProfiles;
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 ListBusinessProfiles {
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";
Integer pageNumber = null;
Integer perPage = null;
String uri = "https://" + host + "/business/v1/profiles/"
+ "agentPartnerId=" + agentPartnerId
+ "&userLanguage=" + userLanguage
+ (targetAudience.isBlank() ? "" : "&targetAudience=" + targetAudience)
+ (pageNumber == null ? "" : "&pageNumber=" + pageNumber)
+ (perPage == null ? "" : "&perPage=" + perPage);
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
Name | 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 the value of this field. |
X-MG-ConsumerIPAddress | String | Optional | IP Address of the system initiating the session |
Query Parameters
Name | Type | Required /Optional | Description |
---|---|---|---|
targetAudience | String | Optional | Enumerated value to tailor MoneyGram’s error messages and field metadata to a in-store, digital or crypto customer |
userLanguage | String | Required | Language used by the user/operator |
agentPartnerId | String | Required | Unique identifier for the agent or partner |
pageNumber | String | Optional | Page number (cursor) returned with each of the transaction results |
perPage | String | Optional | Number of results returned per page |
Response Fields
The following fields are returned in a profileList
array.
Field | Type | Required /Optional | Description |
---|---|---|---|
businessProfileId | String | Required | Business's unique MoneyGram identifier |
businessProfileDetails.partnerBusinessProfileId | String | Optional | Partners business profileId. This will be passed from the partner and mapped to the MoneyGram profileId . |
businessProfileDetails.businessName | String Min Length: 1 Max Length: 100 | Required | Name of the business |
businessProfileDetails.legalEntityName | String Min Length: 1 Max Length: 100 | Required | The legal name of the business |
businessProfileDetails.businessType | String | Optional | Type of business (Enumerated Values) |
businessProfileDetails.businessRegistrationNumber | String | Required | Business registration number |
businessProfileDetails.businessIssueDate | String | Optional | Date of business formation |
businessProfileDetails.businessCountryOfRegistration | String Min Length: 1 max Length: 20 | Required | Business's country of registration |
businessProfileDetails.address.line1 | String Min length: 1 Max Length: 30 | Required | Residence address line 1 |
businessProfileDetails.address.line2 | String Min length: 1 Max length: 30 | Optional | Residence address line 2 (if applicable) |
businessProfileDetails.address.line3 | String Min length: 1 Max length: 30 | Optional | Residence address line 3 (if applicable) |
businessProfileDetails.business.address.city | String Min length: 1 Max length: 20 | Required | Business City |
businessProfileDetails.address.countryCode | String Length: 3 | Required | Country of residence (ISO Alpha-3 Code) |
businessProfileDetails.address.countrySubdivisionCode | String Length: 6 | Optional | State/province of business |
businessProfileDetails.address.postalCode | String Min length: 2 Max length: 6 | Optional | Postal code/ZIP of business |
businessProfileDetails.contactDetails.email | String Min length: 1 Max length: 255 | Optional | Email address |
businessProfileDetails.contactDetails.phone.number | String Min length: 5 Max length: 14 | Optional | Business phone number |
businessProfileDetails.contactDetails.phone.countryDialCode | String Min length: 1 Max length: 3 | Optional | Country calling code NOTE: For country calling code see Reference Data API Module /countries endpoint phoneDialCodes |
businessProfileDetails.lastmodified.operatorId | String | Optional | Unique identifier of the operator that made the last modification to the resource |
businessProfileDetails.lastmodified.lastModifiedDate | String | Optional | Date of the last modification to the resource |
paginationMetadata.totalItems | String | Optional | Total number of items on all pages |
paginationMetadata.currentPage | String | Optional | Current page number |
paginationMetadata.perPage | String | Optional | Page size |
paginationMetadata.totalPages | String | Optional | Total number of pages |
paginationMetadata.links.pageNumber | String | Optional | Page number |
paginationMetadata.links.href | String | Optional | HATEOS links to data |
Updated 18 days ago