Retrieve Transaction History

get

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

The application can invoke the retrieve consumer transaction history and return an array of a consumer's transaction history by profileId."

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

profileId

string

required

Unique id of the profile resource

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)

userLanguage

string

required

Defaults to en-US

Language used by the user/operator

agentPartnerId

string

required

Defaults to 30150519

Unique agent or partner identifier

startDate

date

required

Start date in UTC format of the period from when the transaction events are requested

endDate

date

required

End date in UTC format of the period until when the transaction events are requested

pageNumber

integer

≥ 0

Defaults to 1

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

perPage

integer

≥ 0

Defaults to 1

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

200OK. Returns Consumer Transactions History details for PartnerProfileId Type , Value.

204No Content error.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.