Skip to main content
GET
/
v1
/
settlement-templates
/
{template_id}
Get template
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.keystoneos.xyz/v1/settlement-templates/{template_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "config": {
    "states": [
      "<string>"
    ],
    "initial_state": "<string>",
    "terminal_states": [
      "<string>"
    ],
    "failure_states": [
      "<string>"
    ],
    "transitions": {},
    "compliance": {
      "recheck_at_states": [],
      "entity_providers": [],
      "wallet_providers": []
    },
    "required_roles": [
      "seller",
      "buyer"
    ],
    "actions": {}
  },
  "version": 123,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Path Parameters

​
template_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
slug
string
required
​
name
string
required
​
description
string | null
required
​
config
TemplateConfig · object
required

Settlement workflow definition.

Templates define the settlement process (states, transitions, actions, compliance rules, roles) but NOT integration specifics. Provider and platform details are determined at settlement creation time from the parties and legs, not from the template.

​
version
integer
required
​
is_active
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required