Install a connector

Install a connector by its name and config.

POST /api/payments/connectors/{connector}

Try it

Install a connector

cURL

curl --request POST \
  --url http://localhost/api/payments/connectors/{connector} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Stripe Account",
  "apiKey": "XXX",
  "provider": "Stripe",
  "pollingPeriod": "60s",
  "pageSize": 50
}
'

201

{
  "data": {
    "connectorID": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

connector · enum<string> · required

The name of the connector.

Available options: STRIPE, DUMMY-PAY, WISE, MODULR, CURRENCY-CLOUD, BANKING-CIRCLE, MANGOPAY, MONEYCORP, ATLAR, ADYEN, GENERIC

Body

application/json

Option 1

name · string · required

Example:

"My Stripe Account"

apiKey · string · required

Example:

"XXX"

provider · string · default: Stripe

pollingPeriod · string · default: 120s

The frequency at which the connector will try to fetch new BalanceTransaction objects from Stripe API.

Example:

"60s"

pageSize · integer<int64> · default: 10

Number of BalanceTransaction to fetch at each polling interval.

Required range: x >= 0

Example:

50

Response

201

application/json

OK

data · object · required

Show child attributes

data. connectorID · string · required