Introduction

The business status API module retrieves the current status of a business transaction. The transaction status keeps businesses up to date on the progress of their disbursement. 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 business.

API sequence

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

1. Retrieve a transaction by transactionId | GET /disbursement/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 /disbursement/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 business or beneficiary 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 disbursement

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

2 - Disbursement status

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