API Overview

Creating and Using Security Keys User Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Creating and Using Security Keys

Create a Security Key
- Message-Level Encryption Keys
- PGP Keys
  - Creating PGP Keys
  - Adding PGP Keys to Your Account
  - Granting User Permissions
- REST API Keys
  - Create a P12 Certificate
  - Submit a Certificate Signing Request
  - Create a Shared Secret Key Pair
- Secure Acceptance Keys
- Simple Order API Keys
- SOAP Toolkit Keys

Manage a Security Key
- Deactivate a Key
- Delete a Key
- Search for Keys Using Filters

Meta Key Creation and Management
- Create a Meta Key as a Portfolio User
- Create a Meta Key as a Merchant Account User
- Assign a Meta Key to All Merchants
- Assign a Meta Key to Select Merchants
- Remove a Meta Key from all Merchants
- Remove a Meta Key from Select Merchants
- Convert a Meta Key or Non-Meta Key
- Delete a Meta Key
- Regenerate a Meta Key

Meta Keys in API Requests
- REST API Payment Request with a Meta Key
- Simple Order API Payment Request Using a Meta Key
- SOAP Payment Request Using a Meta Key
- SCMP API Payment Request using a Meta Key

On This Page

REST API Keys

REST API keys are used to enable secure communication between you and National Australia Bank when using the REST API.

The REST API supports these two types of security keys:

Certificates
for using JSON Web Token authentication.

Shared secret key pair
for using HTTP signature authentication.

You can create these keys using the Gateway Portal or submit your own public PEM-formatted certificate to use as your security key.

IMPORTANT

REST API keys expire after 3 years.

Security keys can be used to make any request, including payments. Treat your security keys as you would any secure password.

You must use separate keys for the test and production environments.

When you sign up for a Sandbox account, your confirmation email contains a shared secret key pair.

Back to top