Skip to main content
GET
/
cash-pools
/
{poolId}
Retrieve a cash-pool structure
curl --request GET \
  --url https://sandbox-api.finpace.example/v1/cash-pools/{poolId} \
  --header 'Authorization: Bearer <token>'
{
  "poolId": "cpl_01JQ9M82D4WJ8JE28A6PXVSE3H",
  "name": "Northwind EUR Liquidity Pool",
  "poolType": "physical",
  "currency": "EUR",
  "headerAccountId": "<string>",
  "memberAccountIds": [
    "<string>"
  ],
  "sweepRule": "end-of-day",
  "status": "pending"
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 with client credentials for machine integrations and authorization code for delegated user sessions.

Headers

​
X-Request-Id
string

Caller-generated correlation identifier used for tracing.

Maximum string length: 80

Path Parameters

​
poolId
string
required

Response

Cash pool returned

​
poolId
string
Example:

"cpl_01JQ9M82D4WJ8JE28A6PXVSE3H"

​
name
string
Example:

"Northwind EUR Liquidity Pool"

​
poolType
enum<string>
Available options:
physical,
notional
​
currency
string
Example:

"EUR"

​
headerAccountId
string
​
memberAccountIds
string[]
​
sweepRule
string
Example:

"end-of-day"

​
status
enum<string>
Available options:
pending,
active,
suspended,
closed