Skip to content

Get the tenant's settlement configuration

GET
/v1/settlement/config
curl --request GET \
--url https://example.com/v1/settlement/config \
--header 'Authorization: Bearer <token>'

The tenant’s settlement configuration.

Media typeapplication/json
object
facilitator_url
required
string format: uri
facilitator_credential_ref
required
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
Examplegenerated
{
"facilitator_url": "https://example.com",
"facilitator_credential_ref": "example",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}

Missing or invalid bearer token, or the token’s tenant/user claims are absent. No body.

The tenant has not configured settlement.

Media typeapplication/json

The uniform error body for all 4xx responses that carry one.

object
error
required

A coarse, caller-safe message. Never contains internal state (invariant

string
Examplegenerated
{
"error": "example"
}

An unexpected server-side error. No body (internal detail is never returned to callers, invariant