Authentication

Every Jupico API request uses HTTP Basic authentication and must be sent over HTTPS. Your API username goes in the Basic Auth username field; your API password or secret goes in the password field.

The API playground builds the Authorization header for you once you enter your username and password in the Authorization section of any endpoint page.

Sending a request

curl --location 'https://sandbox-platform.jupico.com/status' \
  --user 'YOUR_API_USERNAME:YOUR_API_PASSWORD' \
  --header 'Accept: application/json'

When you build the header manually, the final value looks like this:

Authorization: Basic BASE64_ENCODED_USERNAME_AND_PASSWORD

Do not include the literal word Basic inside the username or password field. Basic … is only the generated header value, not part of the raw credential pair.

Shared sandbox credentials

Jupico ships a shared sandbox credential set you can use to start testing immediately.

Field	Value
Username	`demoApiUser`
Password	`V8m!xP#l2Qz3`

These credentials are for the shared public sandbox only. Data may reset periodically because multiple developers use the same environment. Ask your Jupico account team for dedicated sandbox credentials when you need persistent test data.

Using the API playground

Every endpoint page in this reference includes an interactive playground.

Open the Authorization section

Expand Authorization on the endpoint page.

Enter your username

For shared sandbox, use demoApiUser.

Enter your password

For shared sandbox, use V8m!xP#l2Qz3.

Send the request

The playground signs the request with your credentials automatically.

Manage API keys in Backoffice

Use Backoffice to create and manage your organization’s API keys.

Only available to existing users, contact sales to setup an account today.

Open Developer settings

Select Developer from the left navigation.

Go to API Keys

Choose API Keys to review existing keys.

Create a new key

Select + New API Key and enter a unique key name.

Store the key securely

Save the generated credential in your secret manager. Jupico does not display it again.

Store production API credentials only in secure server-side configuration. Never commit production credentials to source control or expose them in browser-side code.

Troubleshooting

Error code	Likely cause	Fix
`auth_header_not_present`	The request was sent without an `Authorization` header.	Add Basic Auth credentials to the request.
`auth_invalid_api_token`	The username/password pair or encoded token is invalid for this environment.	Confirm sandbox credentials point to the sandbox URL and production credentials point to production.
`auth_invalid_api_user`	The API user is inactive.	Generate a new key or contact your Jupico administrator.
`auth_invalid_submerchant`	The request references an inactive or unknown submerchant.	Verify the `subMerchantId` and account status.
`auth_invalid_content_type`	The request is not sent as JSON.	Include `Content-Type: application/json`.

See Error Codes for the full list of authentication codes and Error Handling for recommended response handling.

API Overview

API Reference

Resources

Authentication

Sending a request

Shared sandbox credentials

Using the API playground

Manage API keys in Backoffice

Troubleshooting

​Sending a request

​Shared sandbox credentials

​Using the API playground

​Manage API keys in Backoffice

​Troubleshooting

Sending a request

Shared sandbox credentials

Using the API playground

Manage API keys in Backoffice

Troubleshooting