This API call allows clients to get a list of settlement transactions for any connected network account, for a specific settlement. The settlement and its metadata will be returned along with all related settlement transfers in and out of the clients’ network accounts.
Error scenarios:
-
400: Invalid Request Error
-
Occurs when the request parameters are invalid or malformed.
-
Examples: Invalid UUID format for settlementId, invalid enterpriseId format.
-
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 settlement cannot be found.
-
Examples: Settlement ID doesn't exist or the calling client isn't involved in the settlement.
-
500: Internal Server Error
-
Occurs when there's an unexpected server error processing the request.
-
Examples: Database connection issues.