Retrieves the collection of SettlementProfile resources.
This endpoint returns the list of settlement profiles available for use when creating a settlement on a collection order. Profiles that have been disabled in the Collect Portal are not returned.
### Response fields
| Field | Description |
|-------|-------------|
| settlement_profile_id | Unique identifier; pass this value as settlement_profile_id when creating a settlement. |
| name | Display name configured in the Collect Portal. |
| is_default | Whether this profile is the client's default. The default is used when settlement_profile_id is omitted on a settlement creation request. Exactly one profile per client has is_default = true. |
| min_term_count | Minimum number of terms allowed. null if no minimum is configured. |
| max_term_count | Maximum number of terms allowed. null if no maximum is configured. |
| min_term_amount | Minimum amount per term, in the currency's minor unit. null if no minimum is configured. |
The min/max constraints are enforced server-side when creating a settlement — clients should use them to pre-validate inputs before calling POST /v3/collection_orders/{id}/settlement.
### Pagination
Results are paginated. Use page and itemsPerPage query parameters to navigate. The response includes totalItems and a member array.
curl -X GET "/v3/settlement_profiles" \
-H "Authorization: Bearer $POM_API_DOCUMENTATION_API_KEY"Authorization
AuthorizationstringheaderrequiredOAuth 2.0 client credentials Grant
Parameters
pageintegerqueryThe collection page number
Default:1
Response
SettlementProfile collection
total_itemsintegeritems_per_pageintegerpage_countintegermemberSettlementProfile.SettlementProfileOutput-settlement_profile.read[]required
{
"total_items": 100,
"items_per_page": 10,
"page_count": 10,
"member": [
{
"settlement_profile_id": 42,
"name": "Standard 3 months",
"is_default": true,
"min_term_count": 3,
"max_term_count": 6,
"min_term_amount": 1000
}
]
}