Prerequisites

To participate in the Dynamic Authorization, your system needs to respond to a request from the Nium One platform.

These following prerequisites only apply to the authorization Delegated Modeland Extended Model.

These are the prerequisite steps:

Step 1: Integration

Provide your URL [format: <your URL>/api1/v1/authorization]. Nium sends a Delegated Model request payload and receives a response payload with this URL.

Step 2: Security

The API is in the HTTPS protocol. Allow list Nium's IP address to make sure only Nium is the authorized API sender. Aside from HTTPS, there are encryption keys that you and Nium need to share.

API action	Description
API request	You provide a public key to Nium used to encrypt the API request. • Nium encrypts the API request using the given public key. • You decrypt the API request using your private key.
API response	Nium provides a public key to you to encrypt the API response. • You encrypt the API response using your public key. • Nium decrypts the API response using its private key.

API action

Description

API request

You provide a public key to Nium used to encrypt the API request.

• Nium encrypts the API request using the given public key.

• You decrypt the API request using your private key.

API response

Nium provides a public key to you to encrypt the API response.

• You encrypt the API response using your public key.

• Nium decrypts the API response using its private key.

Pretty Good Privacy (PGP) commands

Generate a PGP key: gpg --full-generate-key
List PGP secret keys: gpg --list-secret-keys
Export public key: gpg --output clientfile-public.pgp --armor --export [[email protected]](mailto:[email protected])
Export private key: gpg --output clientfile-secret.pgp --armor --export-secret-key [[email protected]](mailto:[email protected])

Steps to generate a PGP key.

The following steps help you generate a PGP key. The key is generated using Git Bash on Windows.

2.1. Generate a PGP key.

2.1.1 Use the command `gpg---full-generate-key`.

2.1.2 Enter your key type from the options below. Use (1) RSA and RSA.

2.1.3 Select the RSA key length. Nium recommends `2048`.

2.1.4 Select the days for the key expiration. Nium recommends `0 = Key does not expire`.

2.1.5 Enter the name of the key owner, for example, admin, client, etc.

2.1.6 Enter an email address, for example, [email protected].

2.1.7 Enter comments if needed.

2.1.8 Set a passphrase for the private key.

2.2 List the generated key.

2.3 Export the keys using the commands below.

$gpg --output company-pgp-public-key.pgp --armor --export [email protected]

This generates a file under the user home directory: company-pgp-public-key.pgp.

$gpg --output company-pgp-private-key.pgp --armor --export-secret-key [email protected]

This generates a file under the user home directory: company-pgp-private-key.pgp.

2.4 Enter the passphrase to export the private key.

Step 3: Payload

Nium sends the authorization request to your system. The request contains the transaction data and merchant data so you can authorize or decline the request.