Skip to main content

Introduction

The Payments API was designed and implemented by NETOPIA Payments development team to be used in third party applications to cover the payment process.

https://netopia-system.stoplight.io/docs/payments-api/6530c434c2f93-netopia-payments-merchant-api

Prerequisites​

You should have a merchant account with NETOPIA. If you dont yet have one, start by creating it.

NETOPIA Payments administration platform​

Login with your username/password to administration console. From here you'll be able to configure your account, monitor incoming transactions, add users, etc.

NETOPIA gives you the possibility to test the payment process during or after the implemention of your application too by providing a sandbox environment which mirrors the features of production. It can be accessed directly from your production account or by logging in to sandbox.

API KEY​

In order to communicate with the payment API, you need a specific API KEY

From NETOPIA Payments admin -> Profile -> Security, you can generate an API KEY

Example API Key

Note:

  • You shoyld always pass the API KEY in the HTTP Headers of your request
  • You can regenerate/remove/add a new API Key at any time

Once you have an ACTIVE ACCOUNT and an API KEY, you are almost ready to start actual payments via NETOPIA Payments' API

API Diagram​

Api diagram

Payments OpenAPI Specification​

Following the link below you can find the openapi 3.0 specification to have bigger picture on NETOPIA Payments' API

https://secure.sandbox.netopia-payments.com/spec

API Reference​

  • NETOPIA Payments API Version 2
  • Release at 2021