Skip to content

Environments and URLs

You will build against staging and go live against production. The two are completely separate: separate credentials, separate merchant accounts, separate data. Nothing you create in staging exists in production.

Staging

Use staging for all development and testing. Money never moves and you can use the test card and bank numbers freely.

Service URL
Merchant API (GraphQL) https://stg.api.apteanpay.com/
JS SDK https://stg.js.apteansharedservices.com/apteanpay-js/v1
Hosted checkout https://stg.checkout.apteanpay.com/
Merchant portal https://stg.merchant.apteanpay.com/
Payer portal https://stg.payer.apteanpay.com/

Production

Service URL
Merchant API (GraphQL) https://api.apteanpay.com/
JS SDK https://js.apteansharedservices.com/apteanpay-js/v1
Hosted checkout https://checkout.apteanpay.com/
Merchant portal https://merchant.apteanpay.com/
Payer portal https://payer.apteanpay.com/

Warning

Production processes real cards and moves real money. The test card numbers do not work in production, and real card numbers do not work in staging.

Moving from staging to production

Going live is a configuration change, not a code change. If you have built your integration properly, three things vary by environment and nothing else does:

  1. The API host — stg.api.apteanpay.com becomes api.apteanpay.com.
  2. The JS SDK <script src> — stg.js.… becomes js.….
  3. Your credentials — a different API key, tenant ID and tenant secret.

Put all three in configuration. Do not hardcode the staging host: shipping a build that quietly points at staging is the most common cause of "payments succeed but never arrive".

Note

Aptean operates additional internal environments. If Aptean support asks you to test against one, they will give you both the host and a matching set of credentials — the credentials for one environment never work against another.

The GraphQL playground

The staging Merchant API host serves an interactive GraphQL playground when you open it in a browser. Production does not, and it does not allow introspection either. It is the fastest way to explore the schema and try a mutation before you write any code, and several guides on this site are written as playground walkthroughs.

Open https://stg.api.apteanpay.com/, paste your headers into the HTTP HEADERS tab at the bottom of the screen, and you can run queries and mutations directly. The playground's own DOCS and SCHEMA panels are the authoritative reference for every field — these guides cover the common paths, not the whole schema.