Developers

Read the spec. Then call it.

Docs and simulation need no account. A sandbox key follows a verified work email. A live key follows cleared business KYB.

Three steps.

Open docs first, then sandbox, then production after KYB. Default fee: 0.50% (50 bps) of gross at ingress, $1.00 minimum per release. Pricing.

Call once. Listen for every change.

One host for sandbox and production. Bearer keys on initiate; signed webhooks at each transition—or poll status if you miss an event.

  1. Initiate with one key. Send gross, fee, and net on the request with an Idempotency-Key. Retries with the same key return the original settlement.
  2. Track every transition. Signed webhooks fire at each status change. If one is missed, poll GET /v1/settlement/status/{id}. Gross, fee, and net stay on the record.
  3. Reconcile the named states. Finance and engineering read the same labels from staged through settled—see Platform for the full map.
  4. Start from the published spec. The OpenAPI JSON and Quickstart cover the settlement and status routes—not every internal route.

View API documentation

Questions? Answers.

What can we do with no account?

Read the API Documentation, run the open simulation, and download the OpenAPI JSON. The published spec covers the settlement and status routes. It is not an exhaustive list of every internal route.

Do we need sandbox before production?

You should. Sandbox runs the same pipeline with a gsk_sandbox_… key against the same hostnames. Production still requires business KYB and a cleared vendor decision before a gsk_live_… key is issued.

Where does status come back?

On the API. Signed webhooks fire at each transition with the same gross, fee, and net as the clearing record. If delivery fails, poll the status route. See the Quickstart for verify-and-retry patterns.

Is the published spec every route?

No. OpenAPI documents the settlement and status routes your integration calls. Operator and internal routes are not part of the public contract.

When does the sandbox key arrive?

After the work inbox is verified on the Sandbox page. Issuance follows verification—it is not instant and keys are not shown in the browser.

Same spec. Same reference.

Settlement and status routes. Gross, fee, and net on every record.