CSR Service

The CSR service contains endpoints that can be used by customer service reps to manage guest info.

Endpoints

Add Account Comment

POST csr/addAccountComment.json

Add a comment to be linked to a guest’s account using their printed card number. Comment must be fewer than 500 characters.

The following authentication methods are allowed for this endpoint:

JSON Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant identifier (ID) in which to perform the operation.
  • printedCardNumber (String) – (required) Printed card number associated with the account/user requesting the transfer of balances (to this card)
  • comment (Object) – (required) Comment and author information. See CommentSummaryAdd
"result": "success"
JSON Parameters:
 
  • result (String) – (required) addSuccess
  • comment (Object) – (required) See CommentSummaryAdd
"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.

Get Account Comments

GET csr/accountComments.json

Get all comments linked to a printed card number.

The following authentication methods are allowed for this endpoint:

Query Parameters:
 
  • merchantId (Integer) – (required) Paytronix-assigned merchant identifier (ID) in which to perform the operation.
  • printedCardNumber (String) – (required) Printed card number associated with the account/user requesting the transfer of balances (to this card)
"result": "success"
JSON Parameters:
 
  • result (String) – (required) getSuccess
  • comments ([Object]) – (required) See CommentSummaryReturn
"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.

JSON Object Reference

CommentSummaryAdd
JSON Parameters:
 
  • body (String) – (required) The comment to be added to an account. Must be fewer than 500 characters.
  • authorUserId (Integer) – (optional) Comment author’s Paytronix user id
  • authorMerchantId (Integer) – (optional) Merchant id of the merchant that the author is a user for.
CommentSummaryReturn
JSON Parameters:
 
  • body (String) – Comment Body
  • authorUsername (String) – (optional) Comment author’s Paytronix username
  • datetime (Datetime) – Date and time of comment

Error Codes

The following are the possible codes and messages that can be returned by the CSR 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
account_comments_failure.error System error
account_comments_failure.invalid_merchant_id Invalid merchant id
account_comments_failure.invalid_printed_card_number Invalid printed card number
account_comments_failure.invalid_user_name Invalid username
account_comments_failure.invalid_pxuser Unable to locate a PxUser with the given author userId and merchantId.
account_comments_failure.empty_comment The received comment was empty.
account_comments_failure.comment_exceeds_max_length The received comment exceeds the max length of 500 characters.