Mobile Interstitial Service¶
The Mobile Interstitial service provides endpoints which allows a user to retrieve mobile interstitial notifications for their account, as well as marking them as seen.
Topics
Endpoints¶
Get Mobile Interstitials for Guest¶
-
GET
mobileinterstitial/interstitialsForAccount.json
¶ Obtains a list of mobile interstitials for the user which have not been interacted with yet or expired.
The following authentication methods are allowed for this endpoint:
Query Parameters: - merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
- accountId (Integer) – (required) The account ID of the user.
-
"result":
"success"
JSON Parameters: - result (String) – (required)
success
- interstitials (List[Object]) – (required) See
InterstitialInfo
for format of the objects.
- result (String) – (required)
-
"result":
"failure"
JSON Parameters: - result (String) – (required)
failure
- errorCode (String) – (required) The error code of the failure.
- errorMessage (String) – (required) The (human readable) error message of the failure.
- result (String) – (required)
Get Mobile Interstitials for Guest by Printed Card Number¶
-
GET
mobileinterstitial/interstitialsForPrintedCardNumber.json
¶ Obtains a list of mobile interstitials for the user which have not been interacted with yet or expired.
The following authentication methods are allowed for this endpoint:
Query Parameters: - merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
- printedCardNumber (String) – (required) The user’s printed card number.
-
"result":
"success"
JSON Parameters: - result (String) – (required)
success
- interstitials (List[Object]) – (required) See
InterstitialInfo
for format of the objects.
- result (String) – (required)
-
"result":
"failure"
JSON Parameters: - result (String) – (required)
failure
- errorCode (String) – (required) The error code of the failure.
- errorMessage (String) – (required) The (human readable) error message of the failure.
- result (String) – (required)
Mark Interstitials As Seen¶
-
DELETE
mobileinterstitial/markInterstitialsAsSeenForAccount.json
¶ Marks mobile interstitials as seen for this user.
The following authentication methods are allowed for this endpoint:
Query Parameters: - merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
- accountId (Integer) – (required) The account ID of the user.
- interstitialsAndActions (List[Object]) – (required) The list of interstitials to be marked as seen. See
UserActionInterstitial
for format of the objects.
-
"result":
"success"
JSON Parameters: - result (String) – (required)
success
- message (String) – (required) A message describing how many interstitials were deleted, if any.
- result (String) – (required)
-
"result":
"failure"
JSON Parameters: - result (String) – (required)
failure
- errorCode (String) – (required) The error code of the failure.
- errorMessage (String) – (required) The (human readable) error message of the failure.
- result (String) – (required)
Mark Interstitials As Seen By Printed Card Number¶
-
DELETE
mobileinterstitial/markInterstitialsAsSeenForPrintedCardNumber.json
¶ Marks mobile interstitials as seen for this user.
The following authentication methods are allowed for this endpoint:
Query Parameters: - merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
- printedCardNumber (String) – (required) The user’s printed card number.
- interstitialsAndActions (List[Object]) – (required) The list of interstitials to be marked as seen. See
UserActionInterstitial
for format of the objects.
-
"result":
"success"
JSON Parameters: - result (String) – (required)
success
- message (String) – (required) A message describing how many interstitials were deleted, if any.
- result (String) – (required)
-
"result":
"failure"
JSON Parameters: - result (String) – (required)
failure
- errorCode (String) – (required) The error code of the failure.
- errorMessage (String) – (required) The (human readable) error message of the failure.
- result (String) – (required)
Reply Objects¶
-
InterstitialInfo
¶ JSON Parameters: - interstitialId (Integer) – (required) The interstitial ID.
- ctaButton (Object) – (optional) See
CTAButton
for format of the object. - closeButtonColor (String) – (required) The color of the close button.
- interstitialImageUrl (String) – (required) The URL of the image to be displayed for the interstitial.
-
CTAButton
¶ JSON Parameters: - deepLinkValue (String) – (required) The string of the deep link, associated with the deep link type.
- deepLinkType (String) – (required) The deep link type, one of ‘appScreen’, ‘categoryItem’, ‘externalUrl’, ‘menuItem’, or ‘survey’.
- ctaButtonText (String) – (required) The text of the CTA button.
- ctaTextColor (String) – (required) The color of the text of the CTA button.
- ctaButtonBgColor (String) – (required) The color of the background of the CTA button.
-
UserActionInterstitial
¶ JSON Parameters: - interstitialId (Integer) – (required) The interstitial ID.
- clicked (Boolean) – (required) Whether the interstitial was clicked or not.
Error Codes¶
The following are the possible codes and messages that can be returned by the Mobile Interstitial Service.
There are other system-level errors which may be returned which are not documented here.
The caller of the endpoint can use the returned message to display to the end user or, if different wording is desired, can provide their own mapping of code to message.
Code | Message |
---|---|
mobile_interstitial_failure.invalid_merchant_id |
Invalid Merchant Id |
mobile_interstitial_failure.invalid_mobile_interstitial_id |
Invalid mobile interstitial ID |
mobile_interstitial_failure.invalid_mobile_deep_link_id |
Invalid Mobile Deep Link ID |
mobile_interstitial_failure.invalid_card_number |
Invalid Card Number |
mobile_interstitial_failure.system_error |
System error |
mark_interstitials_seen.invalid_card_number |
Invalid Card Number |
mark_interstitials_seen.system |
System Error |