Access to individual endpoints can be restricted per account. If a request to this endpoint returns
403 with error code endpoint_not_enabled and you expect to have access, contact your account representative.List pools
Returns all pools for the authenticated team.GET /v1/pools
Query parameters
Create pool
Creates a new pool.POST /v1/pools
Headers
Body parameters
Example request
Response 201
included_merchants[].id / excluded_merchants[].id are the merchant’s bare ID — no
nmer_/mer_ prefix, unlike the IDs GET /v1/merchants returns. To look one up directly,
prepend nmer_ (e.g. id: "01khfmw45fc139x9w8fsb133yb" →
GET /v1/merchants/nmer_01khfmw45fc139x9w8fsb133yb?extended=1). The merchants request
parameter (here, in Update, and in Pool merchants) takes
this same bare form.Get pool
Retrieves a single pool by its ULID.GET /v1/pools/{id}
Returns the same shape as the create response.
Update pool
Updates an existing pool.networks and merchants are diffed — IDs in the request replace the current set (new IDs are added, missing IDs are removed).
PUT /v1/pools/{id}
Body parameters
Same shape as create pool.200 with the same shape as the create response — included_merchants /
excluded_merchants, not merchants.
Delete pool
Deletes a pool by its ULID.DELETE /v1/pools/{id}