OpusPAY

^{User guide}

×

Menu

Index

Search

(c) Company name, 2020

Gateway Summary - API Keys

Gateway Summary - API Keys

Use Merchant Credentials

Defines if the OpusPAY or Merchant credentials are to be used for authenticating with the gateway

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Checkbox		If checked then when authenticating with the gateway, the merchant account gateway credentials will be used 2. If checked set each field to disabled. 3. If unchecked, enable all API Key fields to allow for entry of opuspay credentials.	N		Y		Unchecked

API Private Key

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text	-	Grey out if Use Merchant Credentials is checked String entered by user 3. If Merchant Credentials is unchecked, this should display an inline error message if the user clicks the Save button without populating this field.	Y	-	Y	-	Disabled	3. Please enter the Gateway API Private Key.

API Public Key

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text	-	Grey out if Use Merchant Credentials is checked String entered by user 3. If Merchant Credentials is unchecked, this should display an inline error message if the user clicks the Save button without populating this field.	Y	-	Y	-	Disabled	3. Please enter the Gateway API Public Key.

API Key 1

This is the first API authorisation key provided by the gateway

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text		Grey out if Use Merchant Credentials is checked String entered by user 3. If Merchant Credentials is unchecked, this should display an inline warning message if the user clicks the Save button without populating this field.	N - but provide warning if not entered		Y		Null	3. Warning : First key has not been entered. Please enter a key value if required by the gateway.

API Key 2

This is the second API authorisation key provided by the gateway

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text		Grey out if Use Merchant Credentials is checked String entered by user Allow null if not required by gateway	N - but provide warning if not entered		Y		Null

API Key 3

This is the third API authorisation key provided by the gateway

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text		Grey out if Use Merchant Credentials is checked String entered by user Allow null if not required by gateway	N		Y		Null

API Key 4

This is the fourth API authorisation key provided by the gateway

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text		Grey out if Use Merchant Credentials is checked String entered by user Allow null if not required by gateway	N		Y		Null