Create Configuration

This endpoint registers a new configuration in Thredd's event delivery system and returns a unique Configuration ID, which should be stored for future updates.

Sample Requests - BIN Sponsor Level

General Configuration

POST api/v1/Configs
{
    "status": "active",
    "messageTypeFilter": [0]
}
        

Program Manager Level Configuration

POST api/v1/Configs
{
    "pmId": 20,
    "status": "active",
    "messageTypeFilter": [1]
}
        

Product Level Configuration

POST api/v1/Configs
{
    "productId": 345678,
    "status": "active",
    "messageTypeFilter": [1, 2]
}
        

Program Manager and Product Level (Combined) Configuration

POST api/v1/Configs
{
    "pmId": 20,
    "productId": 345678,
    "status": "active",
    "messageTypeFilter": [1, 2, 3]
}
        

Sample Requests - Program Manager Level

General Configuration

POST api/v1/Configs
{
    "status": "active",
    "messageTypeFilter": [0]
}
        

Product Level Configuration

POST api/v1/Configs
{
    "productId": 345678,
    "status": "active",
    "messageTypeFilter": [1, 2]
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Documentation

For more information on this endpoint, see Create Configuration.

Body Params

The request payload containing the configuration data to be created.

Represents a request to create a new EDS configuration.

int32 | null

Program Manager Id

int32 | null

Product Id

string
required
length ≥ 1

The configuration status (e.g., "active", "inactive").

messageTypeFilter
array of int32s
required
length ≥ 1

Message type filters.

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)

messageTypeFilter*
Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json