Handle Deposits
An API call will be sent to an operator’s notification callback URL alerting them of pending deposits. After receiving this notification an operator will need to approve or reject the requested deposit.
POST /api/operator/DepositApproval
This method is used to make an authenticated request to approve a specific deposit received via notification callback.
Example Scenario:
- End user makes a deposit on the VIP Connect web component.
- VIP Connect notifies the operator using the notification endpoint URL configured.
- Operator reviews the received deposit request.
- Operator calls deposit approval endpoint on VIP Connect.
- Operator receives successful response status.
Example Request:
{
"PatronId": "1234567890",
"TransactionId": "jason080220231",
"Amount": "89.76",
"BankName": "Rbs Citizens, Na",
"MaskedBankAccountNumber": "************0000",
"BankRoutingNumber": "011401533",
"VipCardNumber": "7210642759",
"LastName": "Joe",
"FirstName": "Smith",
"HomePhoneNumber": "5135552222",
"Location": "192.168.1.1",
"TransactionType": "deposit",
"Timestamp": "",
"InstantPaymentEligible": "true",
"ProductType":"Preferred",
"OneClickDiscountApplied":true,
"OperatorLimits": {
"MinDeposit": 10.00,
"MaxDeposit": 99999.99,
"RemainingDailyDeposit": 1000.0,
"MinWithdraw": 1.00,
"MaxWithdraw": 999999.99,
"WalletBalance": 1000.0
}
}
Parameters List
| Parameter Name | Description | IsRequired | Type | Example |
|---|---|---|---|---|
| patronId | Unique ID to identify end user (generated on operator site) | Yes | Alphanumeric | 1234567890 |
| transactionId* | Unique ID to identify deposit/withdraw request | Yes | Alphanumeric | 9f80db71aa |
| amount | Deposit amount | Yes | decimal | 10.01 |
| bankName | End user selected bank name | Yes | String | Bank of America |
| maskedBankAccountNumber | End user selected bank account number (masked) | Yes | String | ****1234 |
| bankRoutingNumber | Routing number for bank selected | Yes | String | 123456789 |
| vipCardNumber | VIP account number | Yes | String | 714524259 |
| firstName | End user first name | Yes | String | Jane |
| lastName | End user last name | Yes | String | Doe |
| homePhoneNumber | End user's home phone number | Yes | String | 4854587856 |
| location | Device location (IP address of the device) | Yes | String | 127.0.0.1 |
| transactionType | Transaction type of the request | Yes | String | deposit |
| timestamp | Timestamp value when approval request sent | No | DateTime | 2022-10-03T14:23:09.2188558+00:00 |
| instantPaymentEligible | Indicates if the bank supports instant payment | No | Boolean | true |
| productType | VIP product type (VIP Preferred or VIP Online) | Yes | String | preferred |
| oneClickDiscountApplied | Discount on transaction enabled for operator (eligibility determined by oneClickDiscountEligible from Account Inquiry response) | No | Boolean | false |
| operatorLimits.minDeposit | Minumum deposit amount | Yes | decimal | 10.00 |
| operatorLimits.maxDeposit | Maximum deposit amount | Yes | decimal | 99999.99 |
| operatorLimits.remainingDailyDeposit | Remaining daily deposit amount | Yes | decimal | 1000.00 |
| operatorLimits.minWithdraw | Minumum withdraw amount | Yes | decimal | 1.00 |
| operatorLimits.maxWithdraw | Maximum withdraw amount | Yes | decimal | 999999.99 |
| operatorLimits.walletBalance | Patron wallet balance | Yes | decimal | 1000.00 |
note
transactionId is assigned by the Operator. Max Length: 25 characters, Min Length: 8 characters
| Possible ProductType Values | Description |
|---|---|
| preferred | VIP Preferred |
| online | VIP Online |
Response
| Status | Description |
|---|---|
| 200 OK | API received the request and responded |
Example Response
{
"transactionId":"9f80db7112",
"amount":"10.33",
"transactionType":"deposit",
"timestamp":"2022-10-03T14:23:09.2188558+00:00",
"transactionResult":"Success"
}
note
No action needed to reject a deposit request. Operator can review and ignore the deposit notification received.
Configurable Limits
Operators may configure certain deposit limits.
- MaxDeposit - Maximum deposit transaction amount for each session in USD.
- MinDeposit - Minimum deposit transaction amount for each session in USD.