Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Partner Settlements & Transfers

Get Partner Settlement

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.

Requires access token scope: settlement_network_read

get/api/network/v1/enterprises/{enterpriseId}/partners/settlements/{settlementId}

Path parameters

enterpriseIdstring required

The enterprise identifier of the partner. This identifies the partner enterprise making the API request.

settlementIdstring required

The unique identifier of the settlement to retrieve. This is a UUID that uniquely identifies the settlement record.

Query parameters

sourceNetworkAccountIdsstring[]

Filter by specific source network account IDs. When provided, only settlement transfers from these network accounts will be included.

sourceTradingAccountIdsstring[]

Filter by specific source trading account IDs. When provided, only settlement transfers from these trading accounts will be included.

destinationNetworkAccountIdsstring[]

Filter by specific destination network account IDs. When provided, only settlement transfers to these network accounts will be included.

destinationTradingAccountIdsstring[]

Filter by specific destination trading account IDs. When provided, only settlement transfers to these trading accounts will be included.

currenciesstring[]

Filter by specific currencies. When provided, only settlement transfers involving these currencies will be included.

pageNumberstring integer

The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.

pageSizestring

The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.

Response

OK