Guest Management Service

The guest management service provides endpoints to perform actions on guest’s accounts.

Endpoints

Generate And Send Guest Reset Password Code

POST guestmanagement/generateAndSendGuestResetPasswordCode.json

Initiates the reset password flow of the account specified by either the username, accountId, printedCardNumber or email. Only one of these fields should be provided; it is considered an error if more than one is sent. The endpoint will send them a reset password email containing a unique link where they can reset their password.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
  • printedCardNumber (String) – (optional) The printed card number of the user in question
  • username (String) – (optional) The user’s username
  • email (String) – (optional) The user’s email
  • accountId (Int) – (optional) The user’s account id
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
  • email (String) – (required) The email address to where the password information was emailed.
"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.

Send Guest Reset Password Code

POST guestmanagement/sendGuestResetPasswordCode.json

Initiates the reset password flow of the account specified by either the username, accountId, printedCardNumber or email. Only one of these fields should be provided; it is considered an error if more than one is sent. This endpoint should only be used when a third party holds the account of record.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
  • printedCardNumber (String) – (optional) The printed card number of the user in question
  • username (String) – (optional) The user’s username
  • email (String) – (optional) The user’s email
  • accountId (Int) – (optional) The user’s account id
  • resetCode (String) – (required) The reset code is used to securely identify a user. The email the guest receives will have a link to your website with the resetCode added as a get parameter.
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
  • email (String) – (required) The email address to where the password information was emailed.
"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.

Reset Guest Password

POST guestmanagement/resetGuestPassword.json

Accepts the reset password code sent to the guest in the reset password email and a new password and resets the guest’s password. This endpoint should only be used when a third party holds the account of record.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant ID to perform the operation in.
  • resetPasswordCode (Strting) – (required) The code uniquely identifying the user that was passed in to sendGuestResetPasswordCode.
  • newPassword (String) – (required) The password the guest has chosen to be their new password.
"result": "success"
JSON Parameters:
 
  • result (String) – (required) success
"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.