stack/components/payments/docs/connectors.md

Connectors

Currently supported connectors configs and typical default values

• BankingCircle
• CurrencyCloud
• Modulr
• Stripe
• Wise
• DummyPay

BankingCircle

Docs: https://docs.bankingcircleconnect.com/

    Username              string `json:"username" yaml:"username" bson:"username"`
    Password              string `json:"password" yaml:"password" bson:"password"`
    Endpoint              string `json:"endpoint" yaml:"endpoint" bson:"endpoint"`
    AuthorizationEndpoint string `json:"authorizationEndpoint" yaml:"authorizationEndpoint" bson:"authorizationEndpoint"`
    UserCertificate       string `json:"userCertificate" yaml:"userCertificate" bson:"userCertificate"`
	UserCertificateKey    string `json:"userCertificateKey" yaml:"userCertificateKey" bson:"userCertificateKey"`

Sandbox defaults

{
    "username": "username",
    "password": "password",
    "endpoint": "https://sandbox.bankingcircle.com",
    "authorizationEndpoint": "https://authorizationsandbox.bankingcircleconnect.com",
    "userCertificate": "userCertificate",
    "userCertificateKey": "userCertificateKey"
}

Production defaults

{
    "username": "username",
    "password": "password",
    "endpoint": "https://www.bankingcircleconnect.com/",
    "authorizationEndpoint": "https://authorization.bankingcircleconnect.com",
    "userCertificate": "userCertificate",
    "userCertificateKey": "userCertificateKey"
}

CurrencyCloud

Docs: https://www.currencycloud.com/developers/

	LoginID       string   `json:"loginID" bson:"loginID"`
	APIKey        string   `json:"apiKey" bson:"apiKey"`
	Endpoint      string   `json:"endpoint" bson:"endpoint"`
	PollingPeriod Duration `json:"pollingPeriod" bson:"pollingPeriod"`

Demo defaults

{
    "loginID": "loginID",
    "apiKey": "apiKey",
    "endpoint": "https://devapi.currencycloud.com",
    "pollingPeriod": "1m"
}

Production defaults

{
    "loginID": "loginID",
    "apiKey": "apiKey",
    "endpoint": "https://api.currencycloud.com",
    "pollingPeriod": "1m"
}

Modulr

Docs: https://www.modulrfinance.com/modulr-api

    APIKey    string `json:"apiKey" bson:"apiKey"`
    APISecret string `json:"apiSecret" bson:"apiSecret"`
    Endpoint  string `json:"endpoint" bson:"endpoint"`

Sandbox defaults

{
    "apiKey": "apiKey",
    "apiSecret": "apiSecret",
    "endpoint": "https://api-sandbox.modulrfinance.com"
}

Production defaults

{
    "apiKey": "apiKey",
    "apiSecret": "apiSecret",
    "endpoint": "https://api.modulrfinance.com"
}

Stripe

Docs: https://stripe.com/docs/development

Sandbox/Production environment selection is controlled by api key and api secret types.

    PollingPeriod  connectors.Duration `json:"pollingPeriod" yaml:"pollingPeriod" bson:"pollingPeriod"`
    APIKey         string              `json:"apiKey" yaml:"apiKey" bson:"apiKey"`
    PageSize       uint64              `json:"pageSize" yaml:"pageSize" bson:"pageSize"`

Defaults

{
    "pollingPeriod": "1m",
    "apiKey": "apiKey",
    "pageSize": 100
}

Wise

Docs: https://api-docs.wise.com/

Sandbox/Production environment selection is controlled by api key and api secret types.

    APIKey    string `json:"apiKey

Defaults

{
    "apiKey": "apiKey"
}

DummyPay

This connector is used only for testing purposes. It does not connect to any real payment provider.

	Directory            string              `json:"directory" yaml:"directory" bson:"directory"`
	FilePollingPeriod    connectors.Duration `json:"filePollingPeriod" yaml:"filePollingPeriod" bson:"filePollingPeriod"`
	FileGenerationPeriod connectors.Duration `json:"fileGenerationPeriod" yaml:"fileGenerationPeriod" bson:"fileGenerationPeriod"`

Defaults

{
  "directory": "/tmp/payments",
  "filePollingPeriod": "30s",
  "fileGenerationPeriod": "10s"
}

Mangopay

Docs: https://mangopay.com/docs/api-basics/introduction

    ClientID       string `json:"clientID" bson:"clientID"`
    APIKey         string `json:"apiKey" bson:"apiKey"`
    Endpoint       string `json:"endpoint" bson:"endpoint"`
    PollingPeriod  connectors.Duration `json:"pollingPeriod" yaml:"pollingPeriod" bson:"pollingPeriod"`

Sandbox defaults

{
    "clientID": "clientID",
    "apiKey": "apiKey",
    "endpoint": "https://api.sandbox.mangopay.com",
    "pollingPeriod": "2m"
}

Production defaults

{
    "clientID": "clientID",
    "apiKey": "apiKey",
    "endpoint": "endpoint",
    "pollingPeriod": "2m"
}

Moneycorp

Docs: https://corpapi.moneycorp.com/redoc/index.html

    ClientID       string `json:"clientID" bson:"clientID"`
    APIKey         string `json:"apiKey" bson:"apiKey"`
    Endpoint       string `json:"endpoint" bson:"endpoint"`
    PollingPeriod  connectors.Duration `json:"pollingPeriod" yaml:"pollingPeriod" bson:"pollingPeriod"`

Sandbox defaults

{
    "clientID": "clientID",
    "apiKey": "apiKey",
    "endpoint": "https://sandbox-corpapi.moneycorp.com",
    "pollingPeriod": "2m"
}

Production defaults

{
    "clientID": "clientID",
    "apiKey": "apiKey",
    "endpoint": "endpoint",
    "pollingPeriod": "2m"
}