Input Objects
GetPaid GraphQL API is in alpha build and is subject to change without warning. While the overall schemas will not vary much, the fields could undergo major revision. (see GraphQL Best Practices for Versioning (opens in a new tab))
About Inputs
This section gives a quick example on how to form a GraphQL inputs, as well as a quick example on how to call data from regular HTTP.
Specification
CommitTransactionInput
Input parameters for committing a transaction.
INPUT FIELDS
| Name | Description |
|---|---|
| employmentId ( string! ) | The Employment ID of the Employee looking to make a withdrawal. |
| token ( string! ) | A Transaction Token is needed as a unique identifier. |
CreateTransactionInput
Input parameters for creating a transaction.
INPUT FIELDS
| Name | Description |
|---|---|
| amount ( string! ) | The Gross Amount of the wage to be withdrawn. |
| employmentId ( string! ) | The Employment ID of the Employee looking to make a withdrawal. |
CreateUserInput
Input parameters for creating a user.
INPUT FIELDS
| Name | Description |
|---|---|
| companyConnectToken ( string! ) | A unique reference to link this user to an existing Employment. |
| email ( string! ) | The Email field must be unique and not already exist. |
| mobile ( string ) | An optional mobile field (for reference only). |
| name ( string! ) | Full name of the user. |
| password ( string! ) | The supplied Password must have at least 8 alphanumerics, contains a capital, contains a number and cannot be a commonly used phrase. |
DeleteUserInput
Input fields required for Deleting a User.
INPUT FIELDS
| Name | Description |
|---|---|
| userId ( string! ) | The ID of the User to be deleted. |
LoginInput
Input parameters for Login.
INPUT FIELDS
| Name | Description |
|---|---|
| email ( string! ) | The mandatory, unique email field. |
| password ( string! ) | The password that is stored against this User record. |
UpdateBankAccountInput
Input parameters for updating a User's Bank Account.
INPUT FIELDS
| Name | Description |
|---|---|
| accountName ( string! ) | Account name for the associated User. |
| accountNumber ( string! ) | Account number for the associated User. |
| bankName ( string! ) | Name of the Bank. |
UpdateProfileInput
Input parameters for updating a User's Profile.
INPUT FIELDS
| Name | Description |
|---|---|
| mobile ( string! ) | The User's mobile field. |
UserUpdatePasswordInput
Input arguments for updating a user password.
INPUT FIELDS
| Name | Description |
|---|---|
| newPassword ( string ) | The User's new password. |
| oldPassword ( string ) | The User's old password. |
| resetToken ( string ) | A token must be provided to reset the user's password. |
| userId ( string ) | The ID of the User record. |