Create a Transaction

post

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

Creates payout transaction with specific payout option and verifies whether the information collected about the sender is sufficient for identification and regulatory purposes. It returns a unique transaction id that needs to be submitted with subsequent update and commit call.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The payout order payload for subsequent validation.

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

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

serviceOptionRoutingCode

string

Unique identifier of the individual banking, wallet, or card provider for the service option

sendAmount

object

required

receiveCurrencyCode

string

required

Defaults to INR

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

promotionCodes

array of strings

promotionCodes

rewardsNumber

string

length between 0 and 20

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

placeOnPartnerHold

boolean

Request MoneyGram to place the transaction on hold

fundInStore

object

fundingSource

object

targetAccountProfileId

string

Unique Identifier for Target Account Resource

targetAccount

array of objects

length ≥ 0

Dynamic field key/values

targetAccount

sender

object

receiver

object

receiverSameAsSender

boolean

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

transactionInformation

object

receipt

object

partnerTransactionId

string

Partner’s unique session identifier

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 ready for commit flag.

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.