Commit a Transaction

put

https://{host}/payout/v1/transactions/{transactionId}/commit

The Payout Commit API executes the transactionId and completes the payout of funds.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transactionId

string

required

Unique identifier for the transaction resource.

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)]

userLanguage

string

required

Defaults to EN-US

Language used by the user/operator

agentPartnerId

string

required

Defaults to 30150535

Unique agent or partner identifier

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.

Body Params

The request payload with payout details for committing the transaction.

partnerTransactionId

string

Defaults to 5e62c3c3-06da-43bc-86c1-90f5d86a6f90

Partner’s unique session identifier

payoutId

string

Unique identifier for the transaction session

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-SessionId

string

A GUID MoneyGram generates for correlating multiple calls within a transaction session.

X-MG-ConsumerIPAddress

string

IP Address of the system initiating the session.

Responses

200OK

400Bad request. Returns error details.

401Unauthorized. Returns error details.

403Forbidden. Returns error details.

500Internal server error. Returns error details.