Introduction

Last update: 08.2024

The NPGW API has been created using the principles of REST. It will accept and return JSON-encoded bodies and responses, while using standard HTTP response codes & authentication.

All transaction data should only contain ASCII characters.

Further resources

Use and review the OpenAPI specification to explore the NPGW APIs via:

• OpenAPI specification
• Technical Documentation

It’s recommended to utilize the classic Swagger toolset; upload the definition to the Swagger Editor or SwaggerHub.

Alternatively you can use Postman to import the API definition and create your personal collection of requests.

Authentication

Base URLs

<aside> 🛠 Sandbox

https://api-staging.npgw.xyz/merchant-v1/

</aside>

<aside> 🔐 Production

Available from Support

</aside>

Merchant registration

Each API request that you make to NPGW is processed through an API credential linked to your company account.

1. Once you have been successfully setup, our team will provide you with your unique merchantId.
2. Additionally a Merchant Service Account will be created for you to access the API.

Making a Request

The first step for any NPGW API interaction is to validate yourself with the identity service and obtain an access token. This token allows you to execute operations on the gateway APIs with authority, and whilst a single token will expire after 15 minutes, you can use your Merchant Service Account to generate one at any time.

Your Merchant Service Account carries many privileges, so be sure to keep it secure! Do not share your access credentials in publicly accessible areas such as GitHub, client-side code, and so forth.