bankingdetails
API resource to retrieve employee direct deposit details.
Method: GET
Path:/bankingdetails/{txnType}
This end point retrieves direct deposits available for an employee.
| Request Parameters | Description |
|---|---|
|
txnType |
Banking Transaction type. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
headerValue |
Success |
Header value (bank account header details). |
|
accntDetails |
Success |
Account details (bank account details for the user). |
|
piaURL |
Success |
PIA URL. URL to view direct deposit details. |
Method: GET
Path: /bankingdetails/{txnType}/{depositType}
This end point retrieves direct deposit details for an employee based on the deposit type and action type provided.
| Request Parameters | Description |
|---|---|
|
depositType |
Banking deposit type. |
|
txnType |
Banking Transaction type. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
headerValue |
Success |
Header value (bank account header details). |
|
accntDetails |
Success |
Account details (bank account details for the user). |
|
piaURL |
Success |
PIA URL. URL to view direct deposit details. |
Method: GET
Path: /bankingdetails/{txnType}/{depositType}/{actionType}/{searchText}
This end point retrieves direct deposit details based on the deposit type and action type provided.
| Request Parameters | Description |
|---|---|
|
actionType |
Banking action type. |
|
depositType |
Banking deposit type. |
|
searchText |
Search text. |
|
txnType |
Banking Transaction type. |
| Response Parameters | Response Result Type | Description |
|---|---|---|
|
headerValue |
Success |
Header value (bank account header details). |
|
accntDetails |
Success |
Account details (bank account details for the user). |
|
piaURL |
Success |
PIA URL. URL to view direct deposit details. |