Partner route for providing external deposit information tied to an on-chain settlement. This endpoint allows partners to submit information about on-chain deposits that are associated with a specific settlement. The deposits will be tracked and reconciled with the settlement transaction.
Error scenarios:
-
400: Invalid Request Error
-
Occurs when the request parameters are invalid or incomplete.
-
Examples: Empty string supplied for enterpriseId.
-
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 access to the specified settlement.
-
Examples: Enterprise does not have OES license.
-
404: Not Found Error
-
Occurs when the referenced settlement was not found.
-
Examples: Settlement ID doesn't exist, settlement exists but for different partner, partner is inactive.
-
409: Conflict Error
-
Occurs when Deposit information is in conflict.
-
Examples: Depsit information has already been submitted for a different settlement.
-
500: Internal Server Error
-
Occurs when there's an unexpected error processing the request
-
Examples: Database connection failure, transient network error.