Create Configuration - Field Descriptions

The following page details each of the fields that can be used in the request and received in the response when using the Create Configuration endpoint.

Request

The following table describes fields that are included in the body of the request when creating a TC event configuration.

Field	Description	Min Length	Max Length	Type	Mandatory
pmId	The Program Manager ID			Integer	No
productId	The Product ID.			Integer	No
status	The configuration status. For example, `active` or `inactive`.	6	8	String	Yes
messageTypeFilter	The type of filter or filters associated with the configuration. 0 = All (configurable) Transaction/Message Types 1 = Authorisation (0100) 2 = Authorisation Advices (0120) 3 = Online Financial Request (0200) 4 = Online Financial Advice (0220) 5 = Authorisation Reversals (0400) 6 = Authorisation Reversal Advices (0420)	1	1	Array	Yes

Response

The following table describes fields that are included in the response after successfully creating a new TC event configuration.

📘
Note
Fields in bold indicate the start and end of an object.

Field	Description
status	The status of the response. For example, `success`.
response	Objext that contains the response.
content	Object that contains the content of the configuration.
configId	The unique identifier for the created configuration.
pmId	The Program Manager ID associated with the configuration. This is only returned in the response if a valid `pmId` is included in the request.
productId	The Product ID associated with the configuration. This is only returned in the response if a valid `productId` is included in the request.
status	The status of the configuration. For example, `active`.
messageTypeFilter	The list of transaction/message type filter codes for the configuration.
message	The status message for the configuration creation.
content	End of content object.
totalCount	The total number of configurations created in the response.
response	End of response object.

Updated 1 day ago