This API call allows clients to get a list of settlements that involve their accounts and their metadata. Results can be filtered by various parameters and are paginated.
Error scenarios:
-
400: Invalid Request Error
-
Occurs when the request parameters are invalid or malformed.
-
Examples: Invalid UUID format, invalid pagination parameters.
-
401: Authentication Error
-
Occurs when the request is not authorized.
-
Examples: Caller is not a member of the enterprise.
-
403: Permission Denied Error
-
Occurs when the authenticated client doesn't have necessary permissions.
-
Examples: Enterprise does not have OES license.
-
404: Not Found Error
-
Occurs when the specified enterprise cannot be found.
-
Examples: Enterprise ID doesn't exist.
-
500: Internal Server Error
-
Occurs when there's an unexpected server error processing the request.
-
Examples: Database connection issues, query errors.