Skip to main content

TMS APIs

Display Message​

  • General Info:

    • To send a Display Message to the specified users, the user ID or client ID needs to be included in the request body.
    • After the request call is sent, the unique ID of the Display Message will be displayed in response for further tracking.

  • Performing the API Request and Response:

Trigger Transaction​

  • General Info:

    • Specify the user's ID in the request call to trigger the transaction.
    • The information presented to the user during the transaction is encapsulated in the tmsData parameter.
    • Set the transaction's validity period using the retrievalTimeout and tmsTimeOut parameters.
    • Upon sending the request call, obtain the unique transaction ID and its status for further tracking.

  • Performing the Transaction with Push Notification:

  1. Set the push notification provider API key, during the App Creation process.
  2. On the app side, trigger the SetPushTokenEvent via MCSDK.
  3. Add the "push" method from the Trigger Transaction API to your Postman request body.

To get more information about the request body configurations and responses, please follow the Trigger Transaction API methods.

Get Transaction Result​

  • General Info:

    • To retrieve the transaction result, the transaction ID needs to be included in the request call.
    • The transaction result, such as ACCEPTED, REJECTED, and TIMEOUT, will be displayed in the response, if it is available. If no transaction result is known yet, you will get an error message.

  • Performing the API Request and Response:

    • To get more information about the request body configurations and responses, you could check the Get Transaction Result API methods.

Cancel Transaction​

  • General Info:
    • With an simple click, you can cancel an ongoing transaction in your workspace.
    • To execute the request call, the unique ID of the transaction needs to be defined.
  • Performing the API Request and Response:
    • For more information about the request body configurations and responses, you could check the Cancel an Ongoing TMS API methods.