Retrieve Enumerations

get

https://{host}/reference-data/v1/enumerations

Retrieves enumerated values for fields. The data returned by the endpoint gives you the exact enumerated fields and values to display in the UI for customer selection. If a field is an enumerated data-type, the values returned in this API are the only accepted values for the field.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

targetAudience

string

Defaults to AGENT_FACING

Identifies the client. Error messages and attribute metadata tailored to client [agent (store client) vs consumer (digital client)]

agentPartnerId

string

required

Defaults to 30150519

Unique agent or partner identifier

userLanguage

string

required

Defaults to EN-US

Language used by the user/operator

consumerCountryCode

string

length between 3 and 3

Defaults to USA

Consumers country of residence (ISO Alpha-3 code)

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.

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

200Successfully return list of enumerations

204No Content error.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.