Skip to main content
POST
/
v1
/
settlements
Initiate settlement
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotency_key: '<string>',
    template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parties: [
      {
        role: '<string>',
        external_reference: '<string>',
        wallet_address: '<string>',
        name: '<string>',
        chain_id: 123,
        asset_provider: '<string>'
      }
    ],
    legs: [
      {
        leg_type: '<string>',
        instrument_id: '<string>',
        quantity: 1,
        direction: 'deliver',
        party_role: '<string>',
        chain_id: 123,
        token_standard: '<string>',
        external_reference: '<string>'
      }
    ],
    timeout_at: '2023-11-07T05:31:56Z',
    external_reference: '<string>',
    counterparty_parties: [
      {
        platform_slug: '<string>',
        role: '<string>',
        environment_slug: 'production',
        wallet_address_hint: '<string>',
        counterparty_reference: '<string>'
      }
    ]
  })
};

fetch('https://api.keystoneos.xyz/v1/settlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotency_key": "<string>",
  "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_version": 123,
  "external_reference": "<string>",
  "settlement_type": "<string>",
  "parties": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_reference": "<string>",
      "name": "<string>",
      "wallet_address": "<string>",
      "chain_id": 123,
      "asset_provider": "<string>",
      "status": "<string>",
      "confirmed_at": "2023-11-07T05:31:56Z",
      "wallet_address_hint": "<string>",
      "counterparty_reference": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "legs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "leg_type": "<string>",
      "instrument_id": "<string>",
      "chain_id": 123,
      "token_standard": "<string>",
      "quantity": "<string>",
      "direction": "<string>",
      "party_role": "<string>",
      "status": "<string>",
      "external_reference": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "state": "<string>",
  "timeout_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Body

application/json
idempotency_key
string
required
Required string length: 1 - 255
template_id
string<uuid>
required
parties
SettlementPartyInput · object[]
required
Minimum array length: 1
legs
SettlementLegInput · object[]
required
Minimum array length: 1
timeout_at
string<date-time>
required
external_reference
string | null
Maximum string length: 255
counterparty_parties
CounterpartyPartyInput · object[] | null

Response

Successful Response

id
string<uuid>
required
idempotency_key
string
required
platform_id
string<uuid>
required
environment_id
string<uuid>
required
template_id
string<uuid>
required
template_version
integer
required
external_reference
string | null
required
settlement_type
string
required
parties
SettlementPartyRead · object[]
required
legs
SettlementLegRead · object[]
required
state
string
required
timeout_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required