Skip to main content
POST
/
api
/
payments
/
v3
/
connectors
/
install
/
{connector}
Install a connector
curl --request POST \
  --url http://localhost/api/payments/v3/connectors/install/{connector} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": "<string>",
  "companyID": "<string>",
  "name": "<string>",
  "liveEndpointPrefix": "<string>",
  "pageSize": "25",
  "pollingPeriod": "2m",
  "provider": "Adyen",
  "webhookPassword": "<string>",
  "webhookUsername": "<string>"
}
'
{
  "data": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
connector
string
required

The connector to filter by

Body

application/json
​
apiKey
string
required
​
companyID
string
required
​
name
string
required
​
liveEndpointPrefix
string
​
pageSize
integer
default:25
​
pollingPeriod
string
default:2m
​
provider
string
default:Adyen
​
webhookPassword
string
​
webhookUsername
string

Response

Accepted

​
data
string
required

The ID of the created connector