Configuration Endpoints
🔧

Configuration Endpoints

Developers use configuration endpoints to interact with their LinkMoney options, including their security details (IP allowlists, webhook endpoints), aggregator and data formatting options, permitted developers, and anything else pertaining to the developer's genera use of LinkMoney.

View Developer Configuration Details.

Endpoint: GET /configuration

View the properties of your developer configuration.

Parameters

This call requires no parameters.

Example Request

curl -X GET /configuration \
	-H 'Authorization: Bearer {YOUR_BEARER_TOKEN}'

Response

{
	"configuration": {
		"id": "CFG-uuid", 
		"webhookIds": [ WebhookIDs ], 
		"dateFormat": "ISO",
		"type": "plaid",
		"name": "My developer configuration",
		"ipAllowlist": [ ipAddresses ]
	}
}

Create a New Developer Configuration.

Endpoint: POST /configuration

Create a new developer configuration for a LinkMoney integration.

Parameters

For the POST body

FieldTypeDescription
type
string
The type refers to the type of integration the developer requires. This field can be plaid, mx, yodlee, or null in the event that the developer wants to use generic LinkMoney schemas.
dateFormat
string
A string to denote how the developer wants their dates formatted. This can be ISO, UTC or unix. If a type has been specified, this field will be automatically generated with the same date format that the aggregation provider uses.
name
string
A human-readable string to denote the name of the registered configuration.
ipAllowlist
string[]
A list of registered IP addresses for external applications. Not required, but if the developer wants to receive webhooks they must specify at least one IP address in their allowlist.

Example Request

curl -X POST /configuration \
	-H 'Authorization: Bearer {YOUR_BEARER_TOKEN}' \
	-d '{
		"type": "plaid",
		"name": "my developer configuration",
		"ipAllowlist": []
	}'

Response

{
	"configuration": {
		"id": "{YOUR_APPLICATION_ID}", 
		"webhookIds": [ WebhookIDs ], 
		"dateFormat": "ISO",
		"type": "plaid",
		"name": "My developer configuration",
		"ipAllowlist": [ ipAddresses ]
	}
}

Update the Developer Configuration Details.

Endpoint: PATCH /configuration

Edit details of your developer configuration.

Warning: changing configuration details can break multiple parts of your integration, including data validation and endpoint access. Make sure that you are prepared to alter large portions of your LinkMoney integration before you alter your configuration.

Parameters

For the PATCH Body

FieldTypeDescription
ipAddresses
string[]
A list of IP addresses to add to your developer configuration. Note that these will not overwrite IP addresses already in the ipAllowlist of your configuration.
dateFormat
string
Specify a new desired format for your dates from LinkMoney.
type
string
Specify a new type for your integration. Note that this will change all important data schemas for your webhooks / data, and that it may break the calls to certain endpoints.
name
string
Specify a new name for your developer configuration.
ipRemove
string[]
A list of IP addresses to remove from your developer configuration. Note that these will not overwrite IP addresses already in the ipAllowlist of your configuration.

Example Request

curl -X PATCH /configuration \
	-H 'Authorization: Bearer {YOUR_BEARER_TOKEN}' \
	-d '{
		"type": "yodlee",
		"ipAllowlist": ["123.40.21.1"],
		"dateFormat": "unix"
	}'

Response

{
	"configuration": {
		"id": "{YOUR_APPLICATION_ID}", 
		"webhookIds": [ WebhookIDs ], 
		"dateFormat": "unix",
		"type": "yodlee",
		"name": "My developer configuration",
		"ipAllowlist": [ "123.40.21.1" ]
	}
}

Delete Developer Configuration Details.

Endpoint: DELETE /configuration

Delete the developer configuration. Note that running this call will delete the configuration from LinkMoney entirely, but it will not delete any of the developers permissions/privileges, which are managed through the Developer Dashboard.

Parameters

No parameters are required for this call.

Example Request

curl -X DELETE /configuration \
	-H 'Authorization: Bearer {YOUR_BEARER_TOKEN}'

Response

The response to the DELETE call includes only a requestId. Deleting your developer configuration will also permanently delete IP allowlists and cancel all webhook subscriptions for security reasons; the requestId can be used for 10 days to retrieve and restore the developer configuration. After the 10 days elapse, the configuration will be permanently lost. 

{
	"requestId": "{request_id}"
}