Setup guide
Authentication
All Jupiter APIs implement basic authentication, the 'Authorization' header must be present in each request along with your own credentials as shown in the example below:
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Environments
Sandbox environment can be reached from any IP on the internet, while production environment is only allowed to specific IPs.
| Env | URL | Source IP allowed | Source IP allowed |
|---|---|---|---|
| Sandbox | https://sandbox-platform.jupiterhq.com | any | |
| Production | https://platform.jupiterhq.com | specifed IPs |
Sandbox ready
For learning purposes, the public sandbox API key is shared with you below, but once your company signs in for any service, each developer is provided their own set of credentials for sandbox and production environments. Different levels of permissions can be set to grant key access and capabilities to each API (transactions, reporting, provisioning, etc)
TIP: API keys should not be shared or revealed in publicly accessible areas such as GitHub, client-side code, etc.
Public API key
The following key is made available to developers for immediate access. Keep in mind this is a public shared account used by many developers while testing or learning, therefore you'll find data generated by other developers, for this reason, we reset the environment every 24 hours. Once you feel comfortable with our API, don't hesitate to contact us to request your own account.
API Key: ZGVtb0FwaVVzZXI6ZGVtbzIwMTk=
Sandbox test data
SubMerchants
| MerchantIds | Mode |
|---|---|
| 874767775 | Scheduled |
| 874767775 | Dynamic |
Credit card tokens
| Credit card tokens | Hash |
|---|---|
| Token1 | c5ebcb522a1a820e64a2b6104d10efc5963fb3b4e89f13256f832921029ccfac0fd874d3331937658b28824bba90f2ef |
| Token2 | c5ebcb522a1a820e64a2b6104d10efc5d3f5c3adec1177a8ef711611de8073a9431d4db6a4a45701f933164e21c9c670 |
Credit card brands
Cardholder name: any value Expireation date 12/25 CVV: 123
| Card Type | Card Number |
|---|---|
| Airplus | 122000000000003 |
| American Express | 34343434343434 |
| Cartebleue | 5555555555554444 |
| Dankort | 5019717010103742 |
| Diners 1 | 36700102000000 |
| Diners 2 | 36148900647913 |
| Discover card | 6011000400000000 |
| JCB | 3528000700000000 |
| Laser 1 | 630495060000000000 |
| Laser 2 | 630490017740292441 |
| Maestro 1 | 6759649826438453 |
| Maestro 2 | 6799990100000000019 |
| Mastercard 1 | 5555555555554444 |
| Mastercard 2 | 5454545454545454 |
| Visa 1 | 4444333322221111 |
| Visa 2 | 4911830000000 |
| Visa 3 | 4917610000000000 |
| Visa Debit 1 | 4462030000000000 |
| Visa Debit 2 | 4917610000000000003 |
| Visa Electron (UK only) | 4917300800000000 |
| Visa Purchasing | 4484070000000000 |
API endpoints
The Jupiter API is organized around REST. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded, and uses standard HTTP response codes, authentication, and verbs.
Errors
Jupiter uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Jupiter's servers (these are rare).
Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.
Search our blog, contact support. You can also chat live with other developers.
