Returns a settlement for your OES partner account by its ID. This endpoint provides detailed information about a specific settlement, including its status, amounts, and related transfers.
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 partner 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 doesn't belong to this partner.
-
500: Internal Server Error
-
Occurs when there's an unexpected server error processing the request.
-
Examples: Database connection issues.