Retrieve Fields for a Payout

get

https://{host}/reference-data/v1/transaction-fields-receive

Retrieve Fields for a Payout endpoint retrieves all the required, and optional fields, and metadata for a send transaction based a service option, receive amount, and receive currency.

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

posId

string

Unique identifier for point of sale

operatorId

string

Unique identifier for the operator

userLanguage

string

required

Defaults to EN-US

Language used by the user/operator

transactionId

string

Unique identifier for the transaction resource

referenceNumber

string

MoneyGram's reference number for the transaction

amount

number

required

Defaults to 100

Send amount of the the transaction

receiveCurrencyCode

string

required

Defaults to USD

Receive Currency is needed when transacting to a destination country that supports more than one currency. (ISO alpha-3 code)

fundInStore

boolean

Is funds submitted in the store

fundInStoreAgentPartnerId

string

Fund in store Agent Partner ID

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

200Successfully returned receive tranaction fields

204No Content error.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.