OpenAPI Tools - SohoPay

The entire SohoPay API is described by a single OpenAPI 3 spec. If you work in a language without an official SDK, or you prefer Postman over code, the spec gives you a typed, always-current interface to every endpoint.

Get the spec

The spec ships with these docs and powers the API Reference tab:

https://docs.sohopay.xyz/api-reference/openapi.json

It is the same file the interactive playground renders, so it always matches what the endpoint pages document. Download it directly:

curl -O https://docs.sohopay.xyz/api-reference/openapi.json

Try requests in the docs

Every endpoint page in the API Reference has an interactive playground. Paste a sk_test_ key, fill in the fields, and send real requests against the sandbox without leaving the docs — the fastest way to explore an endpoint before writing code.

Only use sandbox keys (sk_test_) in the playground or any third-party tool. Treat sk_live_ keys like production database credentials.

Import into Postman

Import the spec

In Postman, click Import → Link and paste the spec URL above. Postman generates a collection with one request per endpoint, organized by resource.

Set collection variables

Set baseUrl to https://api-sandbox.sohopay.xyz/v1 and add a collection-level Bearer Token auth with your sk_test_ key so every request inherits it.

Send a request

Open Agents → List agents and hit Send. A 200 with your sandbox agents confirms the setup.

Import into Insomnia

Insomnia imports the same spec: Create → Import From → URL, paste the spec URL, and choose Request Collection. Set the base environment to the sandbox URL and add the Authorization: Bearer sk_test_... header in the environment so all requests share it.

Generate a typed client

For languages without an official SDK — Go, Java, Ruby, Rust — generate one from the spec.

openapi-generator

# Go client
openapi-generator generate \
  -i https://docs.sohopay.xyz/api-reference/openapi.json \
  -g go -o ./sohopay-go --package-name sohopay

# Java client
openapi-generator generate \
  -i https://docs.sohopay.xyz/api-reference/openapi.json \
  -g java -o ./sohopay-java

orval (TypeScript, framework-aware)

If you want generated TypeScript hooks (React Query, SWR) instead of the official SDK:

npx orval --input https://docs.sohopay.xyz/api-reference/openapi.json \
  --output ./src/sohopay-client.ts

Generated clients give you types and request plumbing, but not the official SDKs’ automatic retries, idempotency-key generation, or webhook signature verification — implement those yourself (see error handling and webhooks). Official Speakeasy-generated SDKs for more languages, starting with Go, are on the roadmap.

Keep generated code current

Pin the spec you generated from and regenerate on API changes. A simple CI check catches drift:

curl -s https://docs.sohopay.xyz/api-reference/openapi.json \
  | diff - vendored/openapi.json || echo "Spec changed — regenerate the client"

The API is versioned under /v1; breaking changes would ship as a new version, so regeneration within /v1 is additive.

Next steps

API Reference

Endpoint pages with the interactive playground.

TypeScript SDK

The official SDK with retries and idempotency built in.

Code Examples

Runnable, CI-tested examples for every core flow.

​Get the spec

​Try requests in the docs

​Import into Postman

​Import into Insomnia

​Generate a typed client

​openapi-generator

​orval (TypeScript, framework-aware)

​Keep generated code current

​Next steps

API Reference

TypeScript SDK

Code Examples

Get the spec

Try requests in the docs

Import into Postman

Import into Insomnia

Generate a typed client

openapi-generator

orval (TypeScript, framework-aware)

Keep generated code current

Next steps