updateUserPayPercentage

curl --request PUT \
  --url https://sandbox.rollfi.xyz/userPortal/updateUserPayPercentage \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "updateUserPayPercentage",
  "userPayAccountEntity": {
    "userPayAccountEntityId": "7CB1745C-28E6-4E2F-9028-FF34F4E6A3A0",
    "payPercentage": 50
  }
}
'

{
  "userPayAccountEntity": {
    "userPayAccountEntityId": "00779759-E315-45A6-B30C-2EBDFA97FC4A",
    "status": "pending",
    "message": "The User pay account Entity has been updated successfully."
  }
}

User Portal

updateUserPayPercentage

The updateUserPayPercentage API is used to modify the payPercentage for an employee’s bank account

What it does:

Changes the pay allocation if the employee has more than one bank account set up

Notes:

PayPercentage can only be updated for non-primary accounts
The payPercentage that is added/removed from the account will be balanced out by recalculating the payPercentage in the Primary bank account
A bank account with 0% allocation is considered deactivated for payroll purposes but is maintaned for audit. This account will not recieve funds when the employee is paid

PUT

userPortal

updateUserPayPercentage

curl --request PUT \
  --url https://sandbox.rollfi.xyz/userPortal/updateUserPayPercentage \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "updateUserPayPercentage",
  "userPayAccountEntity": {
    "userPayAccountEntityId": "7CB1745C-28E6-4E2F-9028-FF34F4E6A3A0",
    "payPercentage": 50
  }
}
'

{
  "userPayAccountEntity": {
    "userPayAccountEntityId": "00779759-E315-45A6-B30C-2EBDFA97FC4A",
    "status": "pending",
    "message": "The User pay account Entity has been updated successfully."
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method

string

required

userPayAccountEntity

object

required

Show child attributes

Response

userPayAccountEntity

object

required

Show child attributes

addUserBankAccount updateKycInformation