Developer API quickstart

This guide shows you the bare minimum to call the Arca API: where it lives, how to authenticate, and how to make your first request.

Two API surfaces

Every authenticated request needs your access token and your tenant identifier:

• Authorization: Bearer <access token>
• tenant: <your-tenant-slug>

Step 1 — Get an access token

Sign in with your account credentials to get an access token and a refresh token:

POST https://api-tenant.inspireplatform.io/auth/sign-in
Content-Type: application/json

{
  "tenantId": "your-tenant-slug",
  "email":    "dev@yourcompany.com",
  "password": "..."
}

The response includes an accessToken and a refreshToken. When the access token expires, exchange the refresh token at POST /auth/refresh-token.

Step 2 — Make your first call

List customers in your account:

curl https://api-payment.inspireplatform.io/customers?page=0&pagesize=10 \
  -H "Authorization: Bearer eyJ…" \
  -H "tenant: your-tenant-slug"

Or create a payment link:

curl -X POST https://api-payment.inspireplatform.io/payment-links \
  -H "Authorization: Bearer eyJ…" \
  -H "tenant: your-tenant-slug" \
  -H "Content-Type: application/json" \
  -d '{"priceAmount": 5000, "currencyId": "…"}'

What the API covers

Conventions

• Pagination. List endpoints accept page (0-indexed), pagesize, sortby (e.g. createdDate.DESC), and keywords.
• Error shape. Errors come back as JSON with a statusCode and an errors string in the form exception:KEY (e.g. exception:INVALID_CREDENTIALS). Treat these keys as machine-readable enums — some don't have a human-readable English translation, so build your own user-facing copy in your client.
• Rate limits. A global limit of about 300 requests per minute per IP. Public pay endpoints (/payment-links/pay/{hash}, /invoices/pay/{hash}, /orders/pay/{hash}) are tighter: 20 attempts per 10 minutes per IP.
• Webhooks. See the webhooks guide. Note that Arca does not sign outbound webhooks today — validate the tenantId/googleTenantId in the payload body and use HTTPS.

Good to know

• There isn't a separate public sandbox host today — sandbox access is provided as a separate tenant on the same hosts. Ask Arca for sandbox credentials when you start.
• The PDFs and READMEs sometimes describe an @inspire-payments/sdk npm package — that package is aspirational and isn't published yet. Use the raw HTTP API for now.