Retrieve a consumer's profile and receivers

get

https://{host}/consumer/v2/profiles/{profileId}

The Retrieve a Consumer Profile API returns a consumer's profile by profileId. Optionally, it can respond with all the receivers for the consumer and the last transaction sent to each receiver.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profileId

string

required

Defaults to afe6218c-8958-4c2b-8209-16aa6225c65e

consumers unique identifer

Query Params

targetAudience

string

Defaults to AGENT_FACING

Tailors MoneyGram’s error messages and field metadata to an in-store, digital or crypto customer. (Enumerated value)

agentPartnerId

string

required

Defaults to 30150519

Unique agent or partner identifier

userLanguage

string

required

Defaults to en-US

Language used by the user/operator

returnReceivers

boolean

enum

Defaults to true

Return the receiver's for the sender

Allowed:

Headers

X-MG-ClientRequestId

string

Defaults to 4c79b06f-a2af-4859-82c8-28cbb0bf361b

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

IP Address of the system initiating the session.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK. Returns customer.

204No Content error.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.