Create Configuration

The Create Configuration endpoint enables you to create a configuration for a Transaction Confirmation (TC) event.

You can create a configuration for a TC event by making a POST request to the Create Configuration endpoint. For example:

{{base-url}}/eds/api/v1/Configs

The configuration can target one of the following:

• A specific program manager
• A specific product

You can find an example of a Create Configuration request body below. In this example, the ‘Active’ status and the transaction/message type filters ‘1’, ’2’ and ‘3’ are configured against both a certain Program Manager and a Product. As a result, TC events will be activated/sent only for the Program Manager with ID = ‘20’, only for their Product ID = “345678”, and only for transaction/message type ‘1’ - Authorisation (0100), ‘2’ - Authorisation Advice (0120) and ‘3’ - Online Financial Request (0200).

{
  "pmId": 20,
  "productId": 345678,
  "status": "Active",
  "messageTypeFilter": [1, 2, 3 ]
}

If successful, a 201 response is returned with details of configuration, including the unique configId. This should be stored if future updates to the configuration are required.

The following example shows a successful response where a pmId and productId were included in the request.

{
    "status": "success",
    "response": {
        "content": [
            {
                "configId": "5789653-20250602063331",
                "pmId": 20,
                "status": "Active",
                "messageTypeFilter": [1,2,3],
                "message": "Configuration created successfully."
            },
            {
                "configId": "5789654-20250602063331",
                "productId": 345678,
                "status": "Active",
                "messageTypeFilter": [1,2,3],
                "message": "Configuration created successfully."
            }
        ],
        "totalCount": 2
    }
}

👍

More Information

• For more information on the fields in the Create Configuration endpoint, see Create Configuration - Field Descriptions.
• To view the endpoint in the API Explorer, see Create Configuration.