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

fetch('https://api.keystoneos.xyz/v1/settlement-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "config": {
        "states": [
          "<string>"
        ],
        "initial_state": "<string>",
        "terminal_states": [
          "<string>"
        ],
        "failure_states": [
          "<string>"
        ],
        "transitions": {},
        "asset_providers": {},
        "payment_providers": {},
        "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"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

items
SettlementTemplateRead · object[]
required
total
integer
required
limit
integer
required
offset
integer
required