Stage Transfer Completion
Introduction
The Staged Transfer Completion API module enables fund in-store transfer with confirmation numbers to be funded and can be transferred for payout in cash at a MoneyGram store or deposited directly to a bank account or digital wallet.
API Sequence
Staged Transactions Search is the standard model for transferring funds and consists of a three-part API call sequence: search, update and commit a transaction. In this model, MoneyGram will provide a partner with the staged transaction for a consumer which will typically comprise of the transaction ID, senders information, the receviers name, and the confirmation number for the staged trasnaction. The customer will then confirm that is the stage trasnaction and agent will then update the transaction with consumer and transactional information before finally committing/executing the transfer of funds.
- Search for Staged transactions |
POST /transfer/v1/stagedtransactions
POST /transfer/v1/stagedtransactionsTo search a staged transaction, the application must include the sender name, sender phone and confirmationNumber in the API request. The endpoint will successfully respond with an array of staged Traansactions.
- Update a staged transaction |
PUT /transfer/v1/stagedtransactions/{transactionId}
PUT /transfer/v1/stagedtransactions/{transactionId}The application must continue with one staged transaction and update the transactionId resource. The endpoint will validate all the details and successfully respond with a confirmed staged transaction that is ready to commit.
NOTE: MoneyGram will perform real-time validation and compliance screening upon the submitted request. Depending on the results of the validation, the endpoint will respond with pass or fail scenarios. The application must build to handle these error code scenarios and allow the user to correct all errors.
- Commit a staged transaction |
PUT /transfer/v1/stagedtransactions/{transactionId}/commit
PUT /transfer/v1/stagedtransactions/{transactionId}/commitThe application must use the staged commit API to execute the transfer. The endpoint will successfully respond with the transaction reference number, which can be used by the customer to pick up the funds in cash or track the progress of their transfer. The funds will also be marked for settlement.
Endpoints
Take a more detailed view of the transfer API endpoints:
| Name | HTTP method | Endpoints | Description |
|---|---|---|---|
| Search Staged transaction | POST | /transfer/v1/stagedtransactions | The Search for staged transactions API is based on sender information, phone number, or confirmation number. |
| Update a Staged transaction | PUT | /transfer/v1/stagedtransactions/{transactionId} | The Update staged transaction API determines what information to collect from the customer, validates the data for compliance purposes and updates the transactionId resource with the data gathered. |
| Commit a staged transaction | PUT | /transfer/v1/stagedtransactions/{transactionId}/commit | The Commit staged API executes the trasnsactionId and completes the transfer of funds. |
Updated about 20 hours ago