Skip to main content

Create Simple Session for Existing Patron

POST 
/api/patronsession/existing/simple

This endpoint allows an operator to create a simple session for an existing patron using only the essential fields.

Notes:

  • This is a simplified version of the standard existing patron session endpoint.
  • Only minimal required fields are needed to create a session.
  • Intended to be used for the Bank Management SDK UI mode where a patron may modify their bank accounts, but cannot perform a transaction.
tip

Once you obtain a VIP Preferred Card Number from Pavilion Payments, it's best practice to retain this number and use it for all transactions using the existing patron API.

For end users that do have an existing VIP account, submit the end user’s VIP card number to avoid having to send sensitive PII. An end user’s date of birth will be used to validate the cardholder. All fields are required.

Example Scenario:​

  1. Operator makes an authenticated call to VIP Connect API.
  2. VIP Connect API will validate and create a new session.
  3. Session ID and other properties (refer) are returned as response to the operator.
  4. Operator uses the session ID to invoke web component

Request​

Responses​

Returns session details.

Example Success Response:

  {
    "patronId": "0ef56720-47b6-46bc-9a3a-b81bd511d10a",
    "sessionId": "73a747bb-4d3c-4776-af73-945f8fdeaef8",
    "expires": "2024-04-26T17:20:31.6361748+00:00",
    "enrollmentStatus": "complete",
    "vipCardNumber": "7210536159",
    "operatorName": "Operator - 1",
    "depositLimit": 999.99,
    "minDeposit": 10.00,
    "withdrawLimit": 1000.0,
    "minWithdraw": 1.00,
    "transactionId": "tranid1099",
    "transactionAmount": 10.33,
    "returnUrl": "https://www.onlinebettingportal.com/success",
    "patronProductType": "Preferred",
    "oneClickDiscountApplied": false,
    "cancelRedirectUrl": "https://www.onlinebettingportal.com/cancel"
  }

Example Error Response:

note
If an error occurs, an error model will be included in the response as shown below. If an error is returned then the patronErrorMessage should be shown to the user and the VIP Connect web component should NOT be loaded. See Error Responses page for list of all possible errors.
  {
      "patronId": "0ef56720-47b6-46bc-9a3a-b81bd511d10a",
      "sessionId": "00000000-0000-0000-0000-000000000000",
      "expires": "2024-04-26T15:18:30.8687626+00:00",
      "enrollmentStatus": "none",
      "operatorName": "Operator - 1",
      "depositLimit": 999.99,
      "minDeposit": 10.00,
      "withdrawLimit": 1000.0,
      "minWithdraw": 1.00,
      "transactionId": "tranid1099",
      "transactionAmount": 10.33,
      "returnUrl": "https://www.onlinebettingportal.com/success",
      "oneClickDiscountApplied": false,
      "cancelRedirectUrl": "https://www.onlinebettingportal.com/cancel",
      "errorModel": {
          "errorCode": "99",
          "transactionStage": "VIP Account Inquiry",
          "operatorErrorMessage": "Invalid Account.",
          "operatorDeclineDescription": "This transaction has been requested from an account that has been closed. For further assistance please contact Pavilion Gaming Services customer support at 1-800-500-1973 with reference code E-99.",
          "patronErrorMessage": "Sorry, unable to complete this request. Please contact CAMS at 1-800-500-1973 for support using error code E-99."
      }
  }