PUT Update a Consumer Profile

POST /consumer/v2/profiles/{profileId}

Development Guide

The consumer profile update API modifies the address and mobile phone information of a consumer's profile.



1. Prepare headers & authentication:

The application must call the Update Consumer Profile 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




2. Provide profileId as a path parameter:

The application must provide all theprofileId as a path parameter.


🚀

Launch Example Code




3. Provide request body:

The application must provide the following required fields in the request body: profileDetails.address.line1, profileDetails.address.city, profileDetails.address.countrySubdivisionCode, profileDetails.address.countryCode, profileDetails.address.postalCode, profileDetails.mobilePhone.number, profileDetails.mobilePhone.countryDialCode


🚀

Launch Example Code




4. Make the request and handle the response:

The application will call the 'Update a Consumer Profile' endpoint with a PUT HTTP method. The application must build to handle the following response scenarios.


  • Success | Parse the Response | 200 OK HTTP Status
    When the update a consumer profile endpoint responds with a 200 HTTP Status, the response will return the updateSuccess: true, and the consumer profileId that was updated.

  • Failed | Handle the Error | 400 Bad Request HTTP Status
    When the Update a consumer 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 createProfile = 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 + '/consumer/v2/profiles';

    // Step 2: Create the PUT request, headers & params
    const headers = {
        'Content-Type': 'application/json',
        'X-MG-ClientRequestId': uuidv4(), // New UUID for each request tracing
        'Authorization': 'Bearer ' + token,
    };
    const profileId = "profile_Id"
    const request = {
        targetAudience: "AGENT_FACING",
        agentPartnerId: "your_partner_id",
        userLanguage: "en-US",
        profileDetails: {
            address: {
                line: "line1 of address",
                line2: "",
                line3: "",
                city: "Dallas",
                countrySubdivisionCode: "US-TX",
                countryCode: "USA",
                postalCode: "75001"
            },
            mobilePhone: {
                number: "5551231234",
                countryDialCode: "1"
            },
        }
    }

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

updateProfile();
import requests
import uuid
import json

def create_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 + '/consumer/v2/profiles'

    # Step 2: Create the PUT request, headers & params
    headers = {
        'Content-Type': 'application/json',
        'X-MG-ClientRequestId': str(uuid.uuid4()), # New UUID for each request tracing
        'Authorization': 'Bearer ' + token,
    }

    profileId = "profile_Id"
    request = {
        'targetAudience': 'AGENT_FACING',
        'agentPartnerId': 'your_partner_id',
        'userLanguage': 'en-US',
        'profileDetails': {
            'address': {
                    'line1': 'line1 of address',
                    'line2': '',
                    'line3': '',
                    'city': 'Dallas',
                    'countrySubdivisionCode': 'US-TX',
                    'countryCode': 'USA',
                    'postalCode': '75001'
                },
            'mobilePhone': {
                    'number': '5551231234',
                    'countryDialCode': '1'
                },
        }
    }

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

update_profile()

package consumer;

import javax.json.Json;
import javax.json.JsonObject;
import javax.json.JsonObjectBuilder;
import javax.json.JsonWriter;
import java.io.StringWriter;
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 UpdateProfile {

    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";
        String profileId = "profile_id"
        String uri = "https://" + host + "/consumer/v2/profiles/" + profileId;

        // Step 2: Create the PUT request, headers & params
        // Create a JSON object
        JsonObjectBuilder requestBuilder = Json.createObjectBuilder()
                .add("targetAudience", "AGENT_FACING")
                .add("agentPartnerId", "your_partner_id")
                .add("userLanguage", "en-US")
                .add("profileDetails", Json.createObjectBuilder()
                        .add("address", Json.createObjectBuilder().add("line1", "line1 of address")
                                .add("line2", "")
                                .add("line3", "")
                                .add("city", "Dallas")
                                .add("countrySubdivisionCode", "US-TX")
                                .add("countryCode", "USA")
                                .add("postalCode", "75001"))
                        .add("mobilePhone",
                                Json.createObjectBuilder().add("number", "5551231234")
                                        .add("countryDialCode", "1"))
                );

        JsonObject jsonObject = requestBuilder.build();
        // Create a StringWriter to write the JSON string
        StringWriter stringWriter = new StringWriter();
        try (JsonWriter jsonWriter = Json.createWriter(stringWriter)) {
            jsonWriter.writeObject(jsonObject);
        }
        // Get the JSON string from the StringWriter
        String jsonString = stringWriter.toString();

        HttpClient httpClient = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(uri))
                .PUT(HttpRequest.BodyPublishers.ofString(jsonString))
                .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/OptionalDescription
X-MG-ClientRequestIdStringOptionalClient 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


FieldTypeRequired
/Optional
Description
profileIdStringRequiredConsumer's unique identifier



Request Body

FieldTypeRequired
/Optional
Description
targetAudienceString RequiredTailors 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
Max length: 8
RequiredUnique identifier for the agent or partner
userLanguageString
Max length: 6
RequiredLanguage used by the user/operator
profileDetails.address.line1String
Min length: 5
Max length: 30
RequiredResidence address line 1
profileDetails.address.line2String
Min length: 1
Max length: 80
OptionalResidence address line 2 (if applicable)
profileDetails.address.line3String
Min length: 1
Max length: 80
OptionalResidence address line 3 (if applicable)
profileDetails.address.cityString
Min length: 1
Max length: 20
RequiredCity of residence
profileDetails.address.countrySubdivisionCodeString
Length: 6
OptionalState/province of residence

NOTE: For a full list of accepted countries and supported destination country subdivision codes see Reference Data API Module: Retrieve Countries ISO3 endpoint
profileDetails.address.countryCodeString
Length: 3
RequiredCountry of residence (ISO Alpha-3 Code)

NOTE: For a full list of accepted countries and supported destination country subdivision codes see Reference Data API Module: Retrieve Countries ISO3 endpoint
profileDetails.address.postalCodeString
Min length: 2
Max length: 6
OptionalPostal/Zip code of residence
profileDetails.mobilePhone.numberString
Min length: 5
Max length: 14
OptionalPhone number
profileDetails.mobilePhone.countryDialCodeString
Min length: 1
Max length: 3
OptionalCountry dial code

NOTE: For country calling code see Reference Data API Module /countries endpoint phoneDialCodes



Response Fields

FieldTypeRequired/OptionalDescription
updateSuccessStringRequiredFlag to indicate the update of the consumer profile was successful.
profileIdStringRequiredConsumer's unique identifier