Generic Connector

Prerequisites

Before you begin, if you want the Generic Connector to poll automatically your data, you need to create a service on your side that will expose the data we need. This service needs to follow this OpenAPI Specification.

When instanciating the generic connector, you will need to pass an API key that will be used to authenticate the requests to your service. For now, the generic connector will send requests with the api key in the Authorization header.

Example:

Authorization: Bearer <API_KEY>

info

Make sure to create an API key dedicated to Formance. Doing so will improve your auditability and security and will allow you to revoke access to Formance at any time if needed.

Setup

fctl

fctl payments connectors install generic generic.json

curl

curl -X POST "https://$STACK.formance.cloud/api/payments/connectors/generic" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-d @generic.json

With generic.json containing:

{
    "name": "generic",
    "apiKey": "<apiKey>",
    "endpoint": "<endpoint>",
    "pollingPeriod": "2m"
}