Handle Withdrawals
An API call will be sent to an operator’s notification callback URL alerting them of pending withdrawals. After receiving this notification an operator will need to approve or reject the requested withdrawal.
POST /api/operator/WithdrawApproval
This method is used to make an authenticated request to approve a specific withdrawal received via notification callback.
Example Scenario:
- End user makes a withdrawal on the VIP Connect web component.
- VIP Connect notifies the operator using the notification endpoint URL configured.
- Operator reviews the received withdrawal request.
- Operator calls withdrawal approval endpoint on VIP Connect.
- Operator receives successful response status.
Example Request:
{
"transactionId":"9f80db7112",
"amount":10.33,
"bankName":"Bank XYZ",
"maskedBankAccountNumber":"****1234",
"bankRoutingNumber":"12345678",
"vipCardNumber":"7145245259",
"firstName":"Jane",
"lastName":"Doe",
"homePhoneNumber":"4045555555",
"location":"127.0.0.1",
"transactionType":"withdraw",
"timestamp":"2022-10-03T14:23:09.2188558+00:00",
"fundTransferType":"ACH",
"productType":"preferred"
}
Parameters List
| Parameter Name | Description | IsRequired | Type | Example |
|---|---|---|---|---|
| transactionId* | Unique ID to identify deposit/withdraw request | Yes | Alphanumeric | 9f80db71aa |
| amount | Withdrawal 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 | withdraw |
| timestamp | Timestamp value when approval request sent | No | DateTime | 2022-10-03T14:23:09.2188558+00:00 |
| fundTransferType | Type of funds transfer | Yes | String | ACH |
| productType | VIP product type (VIP Preferred or VIP Online) | No | String | preferred |
note
transactionId is assigned by the Operator. Max Length: 25 characters, Min Length: 8 characters
| Possible fundTransferType values | Description |
|---|---|
| ACH | Standard ACH transfer |
| INP | Instant Payment |
| SDA | Same Day ACH |
| 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":"withdraw",
"timestamp":"2022-10-03T14:23:09.2188558+00:00",
"transactionResult":"Success"
}
note
No action needed to reject a withdrawal request. Operator can review and ignore the withdrawal notification received.
Configurable Limits
Operators may configure certain withdrawal limits.
- MaxWithdraw - Maximum withdrawal transaction amount for each session in USD. Default is $999,999.99.
- MinWithdraw - Minimum withdrawal transaction amount for each session in USD. Default is $10.00.