Introduction

The Status API module retrieves the current status of a transaction. The transaction status keeps customers up to date on the progress of their transaction. The status is also accompanied by a sub-status to provide further detail on what’s happening with the transaction and any action required from the customer.

API Sequence

The status API module comprises two endpoints. The process for retrieving a status is as follows:

1. Retrieve a transaction by transactionId | GET status/v1/transactions/{transactionId}
   The application must use transactionId as a path parameter to retrieve the transaction status
   
   OR.
   
   
2. Retrieve a transaction by referenceNumber | GET status/v1/transactions/?referenceNumber={referenceNumber}
   The application must use a reference number as a query parameter to retrieve the transaction status.
   
   

Typically the application will develop a "Status Lookup" or "Transaction History" feature for the customer to query a transaction status. The transaction is then retrieved and the status is displayed back in the UI of the application.

API Sequence Diagram

Endpoints

Example User Journey

• Transaction Status

1 - Retreive a transaction

Look up and retrieve the transaction status by reference number or transaction ID.

2 - Transaction status

MoneyGram returns a transaction summary with its status and sub-status, if applicable.