Skip to main content
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

Sandbox

https://sandbox-platform.jupico.comUse the sandbox for development and testing.

Production

https://platform.jupico.comUse production once you’ve completed the Go-Live Checklist. Requires IP allowlisting.

​
Authentication

All Jupico API requests use HTTP Basic authentication over HTTPS. Pass your API username and password with every request.
A shared sandbox credential (demoApiUser / V8m!xP#l2Qz3) is available for immediate testing. See Authentication for details.
Never expose production credentials in client-side code or source control.

​
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.
Save the X-Request-ID response header — it is the fastest way for Jupico support to locate a specific call. See Responses, Status Codes, and Error Handling.

​
API surface

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

Status

Monitor platform health and availability.

Provisioning

Create applicants, applications, and submerchants to enable processing.

Onboarding Invites

Send and manage merchant onboarding invitations.

Card Transactions

Process card sales, authorizations, captures, refunds, voids, and rollbacks.

eCheck Transactions

Process ACH/eCheck debits, refunds, voids, and tokenization.

Tokenization

Securely tokenize payment instruments for reuse.

Customer

Create, update, and delete customer records.

Session

Authorize browser sessions for hosted experiences.

Checkouts

Spin up hosted checkout experiences for one-time payments.

Payment Links

Generate shareable payment links to collect from any channel.

Invoices

Create, send, void, and manage invoices.

Subscriptions

Build recurring billing with plans and subscriptions.

Installments

Offer installment plans on any transaction.

Payouts

Push funds to merchant bank accounts on demand.

Query

Search transactions, settlements, disputes, and more.

​
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.
  • Errors: Some errors return HTTP 200 with success: false (for example, card declines). See Error Handling and Error Codes.
  • Webhooks: Subscribe to webhooks for real-time onboarding, dispute, payout, subscription, and hosted session events.

​
Reference guides

Authentication

HTTP Basic authentication and shared sandbox credentials.

Environments & Testing Data

Base URLs, sandbox submerchants, and test card data.

Responses

Response envelope, headers, and success/error patterns.

Status Codes

HTTP status codes and integration behavior.

Transaction Status Handling

Handle succeeded, declined, and failed outcomes.

Error Handling

Client- and server-side patterns for handling errors.

Error Codes

Full catalog of code values.

Timeout Handling

35-second timeout, rollback, and retry flows.

Webhooks

Event catalog and delivery expectations.

Go-Live Checklist

Verify credentials, IP allowlisting, and wallets before production.

​
Need help?

Contact your Jupico account team for support and production access.
Last modified on July 15, 2026