BankingCircle Connector

Prerequisites

Before you begin, you need to have a BankingCircle account. If you don't have one, you can sign up for a BankingCircle account here. Make sure you have prepared your BankingCircle API credentials, with the least amount of permissions required to access the functionality of the BankingCircle Connector you plan to use. You can find more information about how to create an API key here.

You will also need a client certificate and the unecrypted key that you can extract from the pfx file of your BankingCircle account:

openssl pkcs12 -in <filename.pfx> -nocerts -nodes | sed -ne '/-BEGIN PRIVATE KEY-/,/-END PRIVATE KEY-/p' > <clientcert.key>
openssl pkcs12 -in <filename.pfx> -clcerts -nokeys | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > <clientcert.cer>

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
curl

read "BC_USERNAME"
read "BC_PASSWORD"
read "BC_ENDPOINT"
read "BC_AUTH_ENDPOINT"
read "BC_USER_CERTIFICATE"
read "BC_USER_CERTIFICATE_KEY"
fctl payments connectors install bankingcircle $BC_USERNAME $BC_PASSWORD $BC_ENDPOINT $BC_AUTH_ENDPOINT $BC_USER_CERTIFICATE $BC_USER_CERTIFICATE_KEY

STACK="stack_123" \
read "BC_USERNAME" && \
read "BC_PASSWORD" && \
read "BC_ENDPOINT" && \
read "BC_AUTH_ENDPOINT" && \
read "BC_USER_CERTIFICATE" && \
read "BC_USER_CERTIFICATE_KEY"
echo -X POST "https://$STACK.formance.cloud/api/payments/connectors/bankingcircle" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-d "{ \
  \"username\": \"$BC_USERNAME\", \
  \"password\": \"$BC_PASSWORD\", \
  \"endpoint\": \"$BC_ENDPOINT\", \
  \"authEndpoint\": \"$BC_AUTH_ENDPOINT\" \
  \"userCertificate\": \"$BC_USER_CERTIFICATE\" \
  \"userCertificateKey\": \"$BC_USER_CERTIFICATE_KEY\" \
}"

Prerequisites​

Setup​

Prerequisites

Setup