Skip to main content
POST
/
api
/
payments
/
connectors
/
{connector}
Install a connector
curl --request POST \
  --url http://localhost/api/payments/connectors/{connector} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Stripe Account",
  "provider": "Stripe",
  "pollingPeriod": "60s",
  "apiKey": "XXX",
  "pageSize": 50
}'
{
  "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
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
  • Option 8
  • Option 9
  • Option 10
  • Option 11
​
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
default:10

Number of BalanceTransaction to fetch at each polling interval.

Required range: x >= 0
Example:

50

Response

OK

​
data
object
required