Retreive a list of business profiles for an agentPartnerId

get

https://{host}/business/v1/profiles

The application can invoke the list business profiles for an agentPartnerId.

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)]

userLanguage

string

required

Defaults to en-US

Language used by the user/operator

agentPartnerId

string

required

Defaults to 30150519

Unique agent or partner identifier

pageNumber

integer

≥ 0

Defaults to 1

Page number (cursor) returned with each of the transaction results

perPage

integer

≥ 0

Defaults to 100

Page number (cursor) returned with each of the transaction results

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 a list of all the businessProfiles for a agentPartnerId.

204No Content error.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.