Create a transaction with auto commit and process the transaction asynchronously.

post

https://{host}/disbursement/v1/transactions/async

The Create API determines what information to collect from the customer, validates the data for compliance purposes and creates the transactionId resource.

Body Params

The payout order payload for subsequent validation.

targetAudience

string

enum

Defaults to AGENT_FACING

Tailors MoneyGram’s error messages and field metadata to an in-store, digital or crypto customer.

Allowed:

agentPartnerId

string

Defaults to 30150519

Unique identifier for the agent or partner

userLanguage

string

Defaults to en-US

Language used by the user/operator

partnerTransactionId

string

Partners Unique identifier for the transaction resource.

destinationCountryCode

string

required

length between 0 and 5

Defaults to USA

Transaction Destination Country (ISO alpha-3 code)

destinationCountrySubdivisionCode

string

Defaults to US-MN

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 code to identify the individual transaction method

sendAmount

object

required

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)

promotionCodes

array of strings

promotionCodes

sender

beneficiary

transactionInformation

object

targetAccount

object

attachments

array of objects

attachments

additionalDetails

array of objects

length ≥ 0

Dynamic field key/values

additionalDetails

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

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.