> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jupico.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Get started with the Jupico API to onboard merchants, process payments, manage payouts, and run your platform.

The Jupico API is organized around REST. Our API uses predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.

## Base URLs

<CardGroup cols={2}>
  <Card title="Sandbox" icon="flask">
    `https://sandbox-platform.jupico.com`

    Use the sandbox for development and testing.
  </Card>

  <Card title="Production" icon="globe">
    `https://platform.jupico.com`

    Use production once you've completed the [Go-Live Checklist](/api-reference/go-live-checklist). Requires IP allowlisting.
  </Card>
</CardGroup>

## Authentication

All Jupico API requests use [HTTP Basic authentication](/api-reference/authentication) over HTTPS. Pass your API username and password with every request.

```bash theme={null}
curl --location 'https://sandbox-platform.jupico.com/status' \
  --user 'YOUR_API_USERNAME:YOUR_API_PASSWORD' \
  --header 'Accept: application/json'
```

<Info>
  A shared sandbox credential (`demoApiUser` / `V8m!xP#l2Qz3`) is available for immediate testing. See [Authentication](/api-reference/authentication) for details.
</Info>

<Warning>
  Never expose production credentials in client-side code or source control.
</Warning>

## Responses at a glance

Every response includes an HTTP status code and a JSON body. Always inspect both — an HTTP `200` can still represent a declined payment.

```json theme={null}
{
  "success": true,
  "code": "0",
  "message": "succeeded",
  "data": {},
  "errors": [],
  "documentation": "https://docs.jupico.com/reference"
}
```

Save the `X-Request-ID` response header — it is the fastest way for Jupico support to locate a specific call. See [Responses](/api-reference/responses), [Status Codes](/api-reference/status-codes), and [Error Handling](/api-reference/error-handling).

## API surface

The Jupico API is grouped into resource families that map to common payments workflows.

<CardGroup cols={2}>
  <Card title="Status" icon="signal" href="/api-reference/status/check-api-status">
    Monitor platform health and availability.
  </Card>

  <Card title="Provisioning" icon="user-plus" href="/api-reference/provisioning/create-an-applicant">
    Create applicants, applications, and submerchants to enable processing.
  </Card>

  <Card title="Onboarding Invites" icon="envelope" href="/api-reference/onboarding-invites/create-an-invite">
    Send and manage merchant onboarding invitations.
  </Card>

  <Card title="Card Transactions" icon="credit-card" href="/api-reference/card-transactions/process-a-card-sale">
    Process card sales, authorizations, captures, refunds, voids, and rollbacks.
  </Card>

  <Card title="eCheck Transactions" icon="money-check" href="/api-reference/echeck-transactions/process-an-echeck-sale">
    Process ACH/eCheck debits, refunds, voids, and tokenization.
  </Card>

  <Card title="Tokenization" icon="key" href="/api-reference/tokenization/tokenize-raw-card-data">
    Securely tokenize payment instruments for reuse.
  </Card>

  <Card title="Customer" icon="user" href="/api-reference/customer/create-a-customer">
    Create, update, and delete customer records.
  </Card>

  <Card title="Session" icon="browser" href="/api-reference/session/create-a-browser-session">
    Authorize browser sessions for hosted experiences.
  </Card>

  <Card title="Checkouts" icon="cart-shopping" href="/api-reference/checkouts/create-a-checkout-session">
    Spin up hosted checkout experiences for one-time payments.
  </Card>

  <Card title="Payment Links" icon="link" href="/api-reference/payment-links/create-a-payment-link">
    Generate shareable payment links to collect from any channel.
  </Card>

  <Card title="Invoices" icon="file-invoice-dollar" href="/api-reference/invoices/create-an-invoice">
    Create, send, void, and manage invoices.
  </Card>

  <Card title="Subscriptions" icon="rotate" href="/api-reference/subscriptions/create-a-subscription">
    Build recurring billing with plans and subscriptions.
  </Card>

  <Card title="Installments" icon="calendar" href="/api-reference/installments/create-an-installment-plan">
    Offer installment plans on any transaction.
  </Card>

  <Card title="Payouts" icon="money-bill-transfer" href="/api-reference/payouts/create-a-payout-instruction">
    Push funds to merchant bank accounts on demand.
  </Card>

  <Card title="Query" icon="magnifying-glass" href="/api-reference/query/list-transactions">
    Search transactions, settlements, disputes, and more.
  </Card>
</CardGroup>

## Conventions

* **HTTP verbs:** Most endpoints use `POST`, even for read operations, to accept structured query bodies.
* **Identifiers:** Resource IDs are strings. Always treat them as opaque.
* **Timeouts:** Transaction and tokenization operations time out at 35 seconds. See [Timeout Handling](/api-reference/timeout-handling).
* **Errors:** Some errors return HTTP `200` with `success: false` (for example, card declines). See [Error Handling](/api-reference/error-handling) and [Error Codes](/api-reference/error-codes).
* **Webhooks:** Subscribe to [webhooks](/api-reference/webhooks) for real-time onboarding, dispute, payout, subscription, and hosted session events.

## Reference guides

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    HTTP Basic authentication and shared sandbox credentials.
  </Card>

  <Card title="Environments & Testing Data" icon="flask" href="/api-reference/environments-testing-data">
    Base URLs, sandbox submerchants, and test card data.
  </Card>

  <Card title="Responses" icon="code" href="/api-reference/responses">
    Response envelope, headers, and success/error patterns.
  </Card>

  <Card title="Status Codes" icon="signal" href="/api-reference/status-codes">
    HTTP status codes and integration behavior.
  </Card>

  <Card title="Transaction Status Handling" icon="list-check" href="/api-reference/transaction-status-handling">
    Handle `succeeded`, `declined`, and `failed` outcomes.
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/api-reference/error-handling">
    Client- and server-side patterns for handling errors.
  </Card>

  <Card title="Error Codes" icon="list" href="/api-reference/error-codes">
    Full catalog of `code` values.
  </Card>

  <Card title="Timeout Handling" icon="clock" href="/api-reference/timeout-handling">
    35-second timeout, rollback, and retry flows.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/api-reference/webhooks">
    Event catalog and delivery expectations.
  </Card>

  <Card title="Go-Live Checklist" icon="rocket" href="/api-reference/go-live-checklist">
    Verify credentials, IP allowlisting, and wallets before production.
  </Card>
</CardGroup>

## Need help?

Contact your Jupico account team for support and production access.