Approvals
Contains all endpoints regarding approval requests. Approval requests allow child users without direct withdrawal access to create a request to be reviewed.
This feature enables users who do not have direct withdrawal permission to initiate a withdrawal request that can then be reviewed by a user with approval permission.
Approvers have the option to approve or reject a request, while users who initiate a request have the ability to only cancel their own request.
Fetch approval requests
GET
https://api.aquanow.io/accounts/v1/approval
Fetches the approval(s) given by the query parameter.
NOTE: One of startTime
or approvalId
must be given as a query parameter. Query parameters can not be combined.
Query Parameters
Name | Type | Description |
---|---|---|
startTime | string | Pagination token that can be used to query more data NOTE: startTime must be within a 90 day range |
approvalId | string |
|
Returns an ApprovalsObject.
Create an approval request
POST
https://api.aquanow.io/accounts/v1/approval
Please specify either grossQuantity
or quantity
inside the payload.
Request Body
Name | Type | Description |
---|---|---|
action* | string |
|
payload* | obj | Contains an ApprovalsPayloadObject |
String |
Returns an ApprovalsObject.
Cancel an approval request
DELETE
https://api.aquanow.io/accounts/v1/approval
NOTE: Users can only cancel their own approval requests while the request status is PENDING
.
Request Body
Name | Type | Description |
---|---|---|
approvalId* | string | approvalId of approval request |
Returns an ApprovalsObject.
Review an approval request
POST
https://api.aquanow.io/accounts/v1/approval/review
User with approver permissions can approve or reject an approval request while the status is PENDING
.
Request Body
Name | Type | Description |
---|---|---|
action* | string |
|
approvalId* | string | approvalId of approval request |
comment | string | Comment set by reviewer |
Returns an ApprovalsObject.
Last updated