Configure Header

This page allows user to configure the header structure for a Gateway API.

Endpoint URL

URL to be called for the request or response

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Text		User to enter URL address	Y		Y		Null	Please enter an endpoint address

Defines additional parameters to be added to the URL address when calling the gateway API.

Technical Note: Does this function require a capability to define the construct of the URL e.g. characters between parameters ?

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Grid		Sort on parameter name
Text	Parameter Name	User can enter any text Hyperlink the Parameter Name and if selected allow for the edit of the row within the grid	Y		Y			Please enter a Parameter Name
ComboBox	Mapped Field	Allows for the selection of any opuspay field Allows for the selection of any Custom Field defined in the API Configuration Rule for that specific gateway	Y		Y			Please select a mapped field

Adds a new row into the grid

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button		When selected add a new row into the grid in edit mode

Delete a row in the grid

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button		When selected pop-up the Delete message

Delete Alert Pop-Up

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Pop-Up		If Yes is selected then delete the row, close pop-up and return to the active tab (the tab that the user was in at the time of pressing the cancel button) in view mode If No, close pop-up and continue to edit the Active tab

Defines additional parameters to be added to the header when calling the gateway API.

Technical Note: Does this function require a capability to define the construct of the header e.g. characters between parameters ?

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Grid		Sort on parameter name
Text	Parameter Name	User can enter any text Hyperlink the Parameter Name and if selected allow for the edit of the row within the grid	Y		Y			Please enter a Parameter Name
ComboBox	Mapped Field	Allows for the selection of any opuspay field Allows for the selection of any Custom Field defined in the API Configuration Rule for that specific gateway	Y		Y			Please select a mapped field

Adds a new row into the grid

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button		When selected add a new row into the grid in edit mode

.

Delete a row in the grid

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Button		When selected pop-up the Delete message

Delete Alert Pop-Up

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Pop-Up		If Yes is selected then delete the row, close pop-up and return to the active tab (the tab that the user was in at the time of pressing the cancel button) in view mode If No, close pop-up and continue to edit the Active tab

Defines what type of call is being made on the gateway API

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
RadioButton		User can select from either: Post Get	Y		Y		Post	Please select a call type

These are tabs where the user can construct the Response or the Request for the API Configuration Rule

Type	Notes	Rules	Compulsory	Format	Edit	Size	Default	Error Message
Tabs		Provide tabs for: Response Request