Merchant API

The Tieto E-commercePayment Gateway Sandbox also allows you to test the platform using Merchant APIs, simulating end-to-end payment flows, status checks, and refund logic without using the user interface. This is ideal for developers who want to integrate EGW directly into their e-commerce systems or platforms.

In sandbox mode, you can test core card payment operations using the Unified Merchant API. The following functions are available:

• Initiate Payments

  • Create CIT (Customer Initiated Transaction) and MIT (Merchant Initiated Transaction) requests

  • Supported for card-based and token-based flows only

• Check Payment Status - Retrieve the current status of a payment using the GET /payments/{id} endpoint.

• Cancel or Capture Payments - Perform follow-up actions like:

  • Cancel a pre-authorized payment

  • Capture a previously authorized payment

• Manage Tokens

  • Get token status

  • Deactivate or cancel a stored card token

Limitation

In sandbox mode, API access is limited to the following operations:

• Card payment operations (e.g., initiate, check status)

• Token-based flows (e.g., token creation and cancellation)

Account-to-Account (A2A) payments and Click-to-Pay are not available via API in sandbox. These flows can only be tested via the Gateway-hosted checkout page.

Testing Data

• Cardholder Name: Any value

• Card Number:

  • 5186 0000 0000 0005 – Successful authorization

  • 5186 0000 0000 0013 – Failed authorization

• Expiry Date: Any valid future date (e.g., 12/28)

• CVV: Any 3-digit number (e.g., 123)

All data is simulated. No real authorization takes place, and responses are based on predefined sandbox rules.

Getting Started with API Access

To begin using the API in sandbox mode, follow these steps to generate your test credentials:

1. Log in to the Merchant Portal using your sandbox account.

2. In the left-hand menu, go to: Settings → Shop Settings → Technical Information

3. If you haven’t generated credentials yet, you will see the message: “API Client ID and API Secret are not yet generated.”

4. Click the “Generate Credentials” button. The sandbox will create:

   • API Client ID

   • API Secret

5. You can copy the credentials directly from the UI and store them securely for testing.

6. If needed, the API Secret can be regenerated at any time from the same view.

These credentials are valid only for the sandbox environment and cannot be used in production.

Sandbox API URLs

• Authentication endpoint URL - https://ecomm.api.tietoevry.com/auth/realms/participants-tietoevry/protocol/openid-connect/token

• API base URL - https://sandbox-api.ecomm.api.tietoevry.com

These URLs are already set-up in the provided postman environment and collection.

For detailed API specifications and examples, please refer to the official documentation

Merchant Unified API

API Usage Guide

Follow these steps to start testing EGW APIs using Postman:

1. Import Postman Files

   • Download and import the Postman environment and API collection provided by Tietoevry.

2. Configure Environment

   • Open the imported environment.

   • Update it with your sandbox Client ID and Client Secret (from Shop Settings → Technical Information).

3. Retrieve Access Token

   • Go to the collection folder: Unified Merchant API → "Get access token" request

   • Execute the "Get access token" request

   • Note: the request needs to be re-executed when the token expires

4. Send API Requests

   You can now test the following endpoints from the collection:

   • CIT/MIT initiation with cards and tokens

   • Get payment status

   • Cancel or capture payments

   • Get token status / Deactivate token

Downloads:

955B

EGW Sandbox.postman_environment.json

Open

21KB

E-Commerce Payment Gateway.postman_collection.json

Open