Prerequisites
Before you start, make sure you have:- A Jupico platform account or access to the shared public sandbox credentials (see Step 1 below).
- A sandbox submerchant ID.
- A server-side environment where you can safely store API credentials.
- A front-end page where you can render Jupico web components.
- A local or hosted HTTPS environment for wallet testing when using Apple Pay or Google Pay.
1
Choose an environment
Jupico uses separate sandbox and production environments. Use sandbox to validate account setup, tokenization, transactions, and payout flows before production access is enabled.UsernamePasswordOnce your platform signs up, you will receive your own set of credentials for both the sandbox and production environments, specific to your platform. Different permission levels can be configured to grant key access and capabilities to each API — transactions, reporting, provisioning, and more.To create your own account and credentials, contact sales.
Use the public sandbox credentials below for exploration, then replace them with your platform-specific sandbox and production credentials as soon as your account is provisioned.Sandbox API Key
The credentials above belong to a shared account used by multiple developers. The shared sandbox environment resets every 24 hours. If you are using unique sandbox credentials (for example, as an existing Jupico user), your environment will not reset every 24 hours.
2
Authenticate API requests
Jupico API requests use Basic authentication. Send the When prompted for credentials in a console, terminal, programming library, SDK, or within the documentation, use the following username and password:
Authorization header on every server-to-server API call. All requests must be made over HTTPS and authenticate using standard HTTP Basic authentication.- Calls made over plain HTTP will fail.
- Requests without an
Authorizationheader will also fail.
/status endpoint to confirm your credentials are working:To create your own account and credentials, contact sales.
3
Create or identify a submerchant
Most payment operations require a
subMerchantId. In sandbox, use one of the provided test submerchants listed below. In production, a merchant must be onboarded and approved before it can process payments or receive payouts.Use the onboarding guides to choose the setup that fits your platform:- Hosted onboarding for the fastest launch.
- Flex onboarding for a branded hosted experience.
- Provisioning API when your platform owns the merchant onboarding UI and submits data directly to Jupico.
For more detail on merchant onboarding options, see the Onboarding docs.
4
Create a browser authorization session
Before rendering a web component, your backend must create a browser authorization session. The session tells the component which submerchant, payment methods, amount, and configuration to use. Return the session object to your front end and reuse it for all payment components on the same payment page unless the payment context changes.
5
Render a payment method component
On the client side, load the Jupico web component bundle and render the component that matches your payment flow. Each component type collects sensitive payment details directly through Jupico-controlled tokenization logic, then returns a token to your application.For complete component setup — properties, callbacks, and a full working page — see Web Components.
- Card — Use the credit card form component for card acceptance.
- Bank account — Use the bank account form component for ACH/eCheck.
- Wallets — Use the Apple Pay or Google Pay components with wallet configuration enabled in the authorization session. Wallet testing requires a local or hosted HTTPS environment.
6
Run a test transaction
After tokenization succeeds, send the returned payment token from your front end to your backend. Your backend can then create a transaction request through the Transaction API.Choose the transaction type that matches your use case:Sandbox Credit Card TokensUse these pre-tokenized card tokens in sandbox to simulate a transaction without rendering the web component.
- Sale — Use when the amount is known and you want to charge immediately.
- Authorization — Use when you want to place a hold and capture later.
- Capture — Use to complete a prior authorization.
- Void — Use to cancel an unsettled transaction.
- Refund — Use to return funds after settlement.
Example test cardUse cardholder name any value, expiration 12/25, and CVV 123.
For the full list of test card numbers and test data, see Environments & Testing Data.
7
Confirm operational behavior
Before moving beyond the quickstart, confirm that your integration handles each of the following correctly:
- The test transaction appears in reporting or Backoffice.
- You can query transaction status from your backend.
- Decline and validation errors are handled cleanly.
- Your application stores only non-sensitive tokens and identifiers — never raw card data.
- The expected payout mode for the test submerchant is confirmed.
- Any relevant webhook events are received and validated.
Next steps
Onboarding overview
Choose the right integration level and onboarding setup for your platform.
Web Components
Full setup for card, bank account, Apple Pay, and Google Pay components.
Webhooks
Receive transaction, payout, and account events in real time.
Go-live checklist
Verify credentials, IP allowlisting, and production readiness before switching over.

