API Reference

Complete endpoint reference for the APISettle REST API. All endpoints use the base URL https://api.apisettle.com.

• All request and response bodies are JSON.
• Monetary amounts are strings in USDC micro-units (1 USDC = 1,000,000).
• Timestamps are ISO 8601 UTC.
• List endpoints support cursor pagination via cursor and limit query params.
• Errors return { "error": { "code": "...", "message": "..." } }.

Settlements

Core payment flow: quote, settle, redeem.

Method	Path	Auth	Description
POST	/v1/quote	Service key	Create a signed payment request.
POST	/v1/settle	JWT / Delegate	Execute payment and receive settlement token.
POST	/v1/settlements/:id/redeem	Service key	Consume settlement (single-use, atomic).
POST	/v1/settlements/:id/verify	Service key	Check settlement status without consuming.
GET	/v1/settlements/:id	JWT	Get settlement details.
GET	/v1/settlements	JWT	List settlements with cursor pagination.

Vendor projects with API keys and pricing.

Method	Path	Auth	Description
POST	/v1/services	JWT	Create a service and generate API key.
GET	/v1/services	JWT	List your services.
GET	/v1/services/:id	JWT	Get service details.
PATCH	/v1/services/:id	JWT	Update service (name, pricing, status).
DELETE	/v1/services/:id	JWT	Deactivate a service.
POST	/v1/services/:id/key/rotate	Service key	Rotate API key with grace period.
POST	/v1/services/:id/key/reveal	JWT	Request key reveal link via email.
POST	/v1/services/:id/key/reveal/verify	JWT	Verify reveal token and get key.

Wallet provisioning, delegation, and recovery.

Method	Path	Auth	Description
POST	/v1/wallets	JWT	Register an external Solana wallet.
POST	/v1/wallets/provision	JWT	Create an embedded Turnkey wallet.
GET	/v1/wallets	JWT	List wallets for your account.
POST	/v1/wallets/:id/onboarding	JWT	Check wallet readiness and auto-delegate.
POST	/v1/wallets/:id/delegate	JWT	Set up spending delegation.
POST	/v1/wallets/:id/revoke	JWT	Revoke spending delegation.

Fiat on-ramp via Coinbase or Transak.

Method	Path	Auth	Description
POST	/v1/deposits/fiat	JWT	Create fiat on-ramp session. Auto-provisions wallet.
GET	/v1/deposits	JWT	List deposits.
GET	/v1/deposits/:id	JWT	Get deposit details.

User-approved withdrawals from wallets.

Method	Path	Auth	Description
POST	/v1/withdrawals	JWT	Create a withdrawal intent.
POST	/v1/withdrawals/:id/approve	JWT	Approve withdrawal with Ed25519 signature.
POST	/v1/withdrawals/:id/cancel	JWT	Cancel a pending withdrawal.
GET	/v1/withdrawals/:id	JWT	Get withdrawal details.
GET	/v1/withdrawals	JWT	List withdrawals.

Vendor-initiated non-custodial refunds.

Method	Path	Auth	Description
POST	/v1/refunds	Service key	Create a refund intent.
POST	/v1/refunds/:id/submit	Service key	Submit refund tx hash for validation.
POST	/v1/refunds/:id/cancel	Service key	Cancel a pending refund.
GET	/v1/refunds/:id	Service key	Get refund details.
GET	/v1/refunds	Service key	List refunds.

Machine-to-machine keys with spending limits.

Method	Path	Auth	Description
POST	/v1/delegates	JWT	Create a delegate with spending limits.
GET	/v1/delegates	JWT	List delegates.
GET	/v1/delegates/:id	JWT	Get delegate details.
GET	/v1/delegates/me	Delegate key	Get current key usage and limits.
PATCH	/v1/delegates/:id	JWT	Update delegate limits.
DELETE	/v1/delegates/:id	JWT	Revoke a delegate key.
POST	/v1/delegates/:id/key/rotate	JWT	Rotate delegate key.
POST	/v1/delegates/:id/key/reveal	JWT	Request key reveal link.
POST	/v1/delegates/:id/key/reveal/verify	JWT	Verify reveal and get key.

Account management and settings.

Method	Path	Auth	Description
POST	/v1/accounts	JWT	Create or get account (idempotent).
GET	/v1/accounts/me	JWT	Get current account.
GET	/v1/accounts/me/settings	JWT	Get account settings.
PATCH	/v1/accounts/me/settings	JWT	Update account settings.

Magic link and passkey auth flows.

Method	Path	Auth	Description
POST	/v1/auth/magic-link	None	Request magic link sign-in email.
POST	/v1/auth/magic-link/verify	None	Verify magic link token.
POST	/v1/auth/passkey/register/options	JWT	Get WebAuthn registration options.
POST	/v1/auth/passkey/register/verify	JWT	Verify passkey registration.
POST	/v1/auth/passkey/login/options	None	Get WebAuthn authentication options.
POST	/v1/auth/passkey/login/verify	None	Verify passkey login.
POST	/v1/auth/refresh	Cookie	Refresh access token.
POST	/v1/auth/logout	JWT	Revoke refresh token.

Transactions, spending summary, and health.

Method	Path	Auth	Description
GET	/v1/transactions	JWT	Unified feed: deposits, settlements, transfers.
GET	/v1/spending/summary	JWT	Balance, limits, and deployment flags.
GET	/v1/health	None	Basic health check.
GET	/v1/health/ready	None	Readiness probe (DB + Redis).
POST	/v1/dev/fund	JWT	Fund wallet on devnet (test only).

HTTP	Code	Meaning
400	validation_error	Invalid request body or parameters.
401	unauthorized	Missing or invalid authentication.
402	payment_required	Payment needed. Response includes quote token.
403	forbidden	Authenticated but not authorized for this resource.
404	not_found	Resource doesn't exist.
409	conflict	Resource already exists or state conflict.
410	quote_expired	Quote has passed its expiry window.
410	settlement_expired	Settlement redeem window has elapsed.
429	rate_limited	Too many requests. Back off and retry.