GET Retrieve a Business Profile

GET /business/v1/profiles/{businessProfileId}

Development Guide

The 'Retrieve a Business Profile' endpoint returns a business profile by profileId. The endpoint can also provide all beneficiaries associated with a businessProfileId,



1. Prepare headers & authentication:

The application must call the Retrieve a Business Profile endpoint with a GET HTTP method, providing the OAuth access_token in the header and all other required header and query parameters.


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




2. Provide businessProfileId as a path parameter:

The application must provide the businessProfileId as a path parameter.


🚀

Launch Example Code




3. Provide agentPartnerId as a query parameter:

The application must provide the agentPartnerId as a query parameter.


🚀

Launch Example Code




4. Make the request and handle the response:

The application will call the 'Retrieve a Business Profile' endpoint with a GET HTTP method. The application must build to handle the following response scenarios.


  • Success | Parse the Response | 200 OK HTTP Status
    When the Retrieve a Business Profile endpoint responds with a 200 HTTP Status, the response will return the that was updated.

  • Failed | Handle the Error | 400 Bad Request HTTP Status
    When the Retrieve a Business Profile 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 update request

🚀

Launch Example Code

.




Code Examples

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

const retrieveBusinessProfile = 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 businessProfileId = "business_profile_id";
    const params = {
        targetAudience: "AGENT_FACING",
        userLanguage: "en-US",
        agentPartnerId: "your_partner_id",
    }

    try {
        // Step 3: Send the request and obtain the response
        axios.get(url + "/" + businessProfileId, { 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);
    }
};

retrieveBusinessProfile();
import requests
import uuid
import json

def retrieve_business_profile():

    # 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,
    }

    businessProfileId = "business_profile_id"
    params = {
        'targetAudience': 'AGENT_FACING',
        'userLanguage': 'en-US',
        'agentPartnerId': 'your_partner_id',
    }

    try:
        # Step 3: Send the request and obtain the response
        response = requests.get(url + "/" + businessProfileId, 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)

retrieve_business_profile()
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 RetrieveBusinessProfile {

    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";

        // Mandatory Path params
        String businessProfileId = "business_profile_id";

        String uri = "https://" + host + "/business/v1/profiles/" + businessProfileId + "?"
                + "&agentPartnerId=" + agentPartnerId
                + "&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

NameTypeRequired
/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 the value of this field.
X-MG-ConsumerIPAddressStringOptionalIP Address of the system initiating the session



Path Parameters

NameTypeRequired
/Optional
Description
businessProfileIdStringRequiredBusiness's unique MoneyGram identifier


Query Parameters

NameTypeRequired
/Optional
Description
targetAudienceStringOptionalEnumerated value to tailor MoneyGram’s error messages and field metadata to a in-store, digital or crypto customer
userLanguageStringRequiredLanguage used by the user/operator
agentPartnerIdStringRequired Unique agent or partner identifier



Response Fields

FieldTypeRequired
/Optional
Description
businessProfileIdStringRequiredBusiness's unique MoneyGram identifier
businessProfileDetails.partnerBusinessProfileIdStringOptionalPartners business profileId. This will be passed from the partner and mapped to the MoneyGram profileId.
businessProfileDetails.businessNameString
Min Length: 1
Max Length: 100
RequiredName of the business
businessProfileDetails.legalEntityNameString
Min Length: 1
Max Length: 100
RequiredThe legal name of the business
businessProfileDetails.businessTypeStringOptionalType of business
(Enumerated Values)
businessProfileDetails.businessRegistrationNumberStringRequiredBusiness registration number
businessProfileDetails.businessIssueDateStringOptionalDate of business formation
businessProfileDetails.businessCountryOfRegistrationString
Min Length: 1
max Length: 20
RequiredBusiness's country of registration
businessProfileDetails.address.line1String
Min length: 1
Max Length: 30
RequiredResidence address line 1
businessProfileDetails.address.line2String
Min length: 1
Max length: 30
OptionalResidence address line 2 (if applicable)
businessProfileDetails.address.line3String
Min length: 1
Max length: 30
OptionalResidence address line 3 (if applicable)
businessProfileDetails.business.address.cityString
Min length: 1
Max length: 20
RequiredBusiness City
businessProfileDetails.address.countryCodeString
Length: 3
RequiredCountry of residence (ISO Alpha-3 Code)
businessProfileDetails.address.countrySubdivisionCodeString
Length: 6
OptionalState/province of business
businessProfileDetails.address.postalCodeString
Min length: 2
Max length: 6
OptionalPostal code/ZIP of business
businessProfileDetails.contactDetails.emailString
Min length: 1
Max length: 255
OptionalEmail address
businessProfileDetails.contactDetails.phone.numberString
Min length: 5
Max length: 14
OptionalBusiness phone number
businessProfileDetails.contactDetails.phone.countryDialCodeString
Min length: 1
Max length: 3
OptionalCountry calling code

NOTE: For country calling code see Reference Data API Module /countries endpoint phoneDialCodes
businessProfileDetails.lastmodified.operatorIdStringOptionalUnique identifier of the operator that made the last modification to the resource
businessProfileDetails.lastmodified.lastModifiedDateStringOptionalDate of the last modification to the resource