Skip to main content
REST client

Facilitator

The 2 operations under facilitator, as typed calls on the generated REST client.

1 min read
View MarkdownEdit on GitHub

Facilitator

Available from @codespar/sdk 0.12.0; the version on npm is 0.12.0. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import {  } from "@codespar/sdk";

const  = new ({ : .. });

POST /v1/facilitator/x402/executions

POST/v1/facilitator/x402/executions
Moves money

A 200 here means USDC MOVED.

Ingest and execute a foreign x402 authorization

const  = await ..("post", "/v1/facilitator/x402/executions", {
  : {
    : {
      : "string",
      : "string",
      : "string",
      : "string",
      : "string",
      : "string"
    },
    : {
      : "Example",
      : "string",
      : 0,
      : "string"
    },
    : "string",
    : {
      : "string",
      : "string",
      : "string",
      : "string",
      : 1000,
      : 1,
      : "https://example.com/hook"
    }
  }
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (.) {
  .(.);
}

Parameters, body and every documented response: POST /v1/facilitator/x402/executions in the HTTP reference.

GET /v1/facilitator/x402/executions/{id}

GET/v1/facilitator/x402/executions/{id}

Read one ingested foreign authorization

const  = await ..("/v1/facilitator/x402/executions/{id}", {
  : {
    : "execution_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/facilitator/x402/executions/{id} in the HTTP reference.

Facilitator | CodeSpar