Funnel actions

The funnel provides some actions for your user connections.

List of actions

List of actions available for funnel.

Parameters

type

You can define provider type or connection type with parameter type.

Example to create a bank connector and only list bank providers:

{
    "action": "create",
    "type": "bank"
}

connections

For funnel actions, you can define connections UUID with parameter connections. Warning: "edit" action accept only ONE connection UUID.

Example to edit a connection:

{
    "action": "edit",
    "connections": [
        "82db2f8b-67ae-443f-b64a-44a2ac846f37"
    ]
}

Example to show synchronize three connections:

{
    "action": "sync",
    "connections": [
        "82db2f8b-67ae-443f-b64a-44a2ac846f37",
        "643bd44c-7cc7-464d-a070-123ce72edfd9",
        "e43cfc74-95a0-4469-8aa0-ffaddc0c4502"
    ]
}

country

To limit providers to a country, you can give a country ISO with parameter country.

Warning: if you edit a connection in another country than scope, you will have an error.

Example to create a connection and list only provider in France country:

{
    "action": "create",
    "type": "bank",
    "country": "FR"
}

scope

To limit providers to a scope access.

Warning: if you edit a connection in with another provider scope, you will have an error.

Example to create a connection and list only providers with a user access:

{
    "action": "create",
    "type": "bank",
    "scope": 1
}

provider

To restrict the connection creation to a specified provider, uses provider parameter.

Example for provider id 4 restriction:

{
    "action": "create",
    "type": "bank",
    "provider": 4
}

Warning: this parameter applies only for connection creation

suggestion

To suggest a specific provider.

Example to suggest a named provider:

{
    "action": "suggestion",
    "type": "bank",
    "suggestion": {
        "name": "Iswigo Provider Name",
        "url": "https://www.iswigo.com"
    }
}