Approvals

List Approval Requests

Retrieve a list of approval requests associated with the authenticated user, each containing details such as the request ID, sender ID, recipient ID, amount, status, and timestamps.

  • The status can be one of the following: requested, approved, declined, or cancelled.
  • The list of approval requests is filtered based on the user's permissions and roles.
get/approvals

Request

Query parameters

workflowType'contact' | 'programmable' | 'requestPayment' | 'directPay'

Optional filter for the type of workflow.

statusstring

Optional filter for approval status (comma-separated values).

limitnumber double

Positive integer page size. 0 is rejected.

offsetnumber double

Non-negative integer page offset. Default: 0.

orderBy'createdAt' | 'updatedAt'

Sort payments by a field. Available fields: createdAt, updatedAt (optional).

order'asc' | 'desc'

Sort direction. Available values: asc, desc. (optional).

Response

The list of approval requests was retrieved successfully.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.