Quote a Transaction

post

https://{host}/transfer/v1/transactions/quote

The Quote API creates a transactionId resource and determines the service options, currencies and pricing available to a destination country.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The request payload to fetch fees and payout options

targetAudience

string

enum

Defaults to AGENT_FACING

Enumerated value to tailor MoneyGram’s error messages and field metadata to a in-store, digital or crypto customer

Allowed:

agentPartnerId

string

Defaults to 30150519

Unique identifier for the agent or partner

posId

string

Point of sale identifier of the client performing the API Call

operatorId

string

Operator name or ID of the user performing the transaction. Name or ID must be populated from the agent/partner system and cannot be edited by the user.

userLanguage

string

Language used by the user/operator

destinationCountryCode

string

required

length between 0 and 5

Defaults to IND

Transaction Destination Country (ISO alpha-3 code)

destinationCountrySubdivisionCode

string

Destination state/province is conditionally required when transacting to certain destination countries. (ISO alpha-3 code)

serviceOptionCode

string

Defaults to WILL_CALL

Unique category code to identify the transaction method

sendAmountIncludingFee

boolean

Flag to indicate the transaction amount is to be inclusive of the transaction fee and taxes

sendAmount

object

required

receiveCurrencyCode

string

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

receiverSameAsSender

boolean

Flag to indicate the receiver and sender are the same person. NOTE - If this flag is marked true, receiver.name fields are considered 'Optional' and are not needed to be passed on API request

promotionCodes

array of strings

promotionCodes

rewardsNumber

string

length between 0 and 20

Unique code to apply Loyalty accrual/redemption (MoneyGram Plus Number)

fundInStore

object

additionalDetails

array of objects

length ≥ 0

Dynamic field key/values

additionalDetails

Headers

X-MG-ClientRequestId

string

required

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 quotes with fees and exchange rate for available payout options.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.