Connection Formulas

List Connection Formulas

This resource creates managed connections with vendors in your account, once created a connection is available for use in transactions.

POST

https://api.basistheory.com/orchestration/connection_formulas

Permissions

orchestration:connection_formulas

Request

cURL

curl "https://api.basistheory.com/orchestration/connection/formulas" \
  -H "BT-API-KEY: <PRIVATE_API_KEY>"

Response

    {
      "id": "stripe",
      "display_name": "Stripe Card",
      "method": "card",
      "fields": [
        {
          "key": "private_key",
          "display_name": "Private API Key",
          "required": true,
          "format": "text",
          "secret": true
        }
      ],
      "supported_currencies": [
        "AUD",
        "CAD",
        "NZD",
        "USD",
        ...
      ],
      "supported_countries": [
        "AU",
        "CA",
        "NZ",
        "US",
        ...
      ],
      "supported_features": {
        "three_d_secure_pass_through": false
      }
    }

Resources

Connection Formula Object

Parameter	Type	Description
id	string	Unique identifier for the connection formula
display name	string	Friendly name for the connection formula
fields	array	List of configuration values for the connection.
supported_countries	array	Countries to support with connection
supported_currencies	array	Currencies to support with connection
supported_features	array	Object of supported features (e.g. 3D Secure is allowed)

Supported Features

Here is a table with the requested features and their descriptions:

Feature	Description
three_d_secure_pass_through	Allows merchants to pass through 3D Secure authentication data to the connection.
delayed_capture	Enables merchants to authorize a payment but delay the actual capture of funds until a later time, such as when goods are shipped or services are rendered.
partial_capture	Allows merchants to capture only a portion of the authorized amount, rather than the full amount.
partial_refunds	Enables merchants to issue partial refunds for a portion of a captured payment, rather than refunding the entire amount.
refunds	Allows merchants to issue full refunds for captured payments.
zero_auth	Enables merchants to perform a zero-dollar authorization, which can be useful for validating card details or performing account verification.
void: voidAllowed	Indicates whether the payment gateway supports voiding (canceling) authorized payments that have not yet been captured.

Supported Connection Formulas

We are currently working to add 100+ connections to the supported connections list. The ones below are available for testing and production traffic.

Don't see your Payment Processor listed? Click here to reach out and request a specific Connection Formula or learn more.

Card

id	connection
adyen-card	Adyen
authipay-card	Authipay
authorizenet-card	Authorize.net
braintree-card	Braintree
chaseorbital-card	Chase Orbital
checkoutcom-card	Checkout.com
cybersource-card	CyberSource
dlocal-card	dlocal
ebanx-card	EBANX
fiserv-card	Fiserv
nmi-card	NMI
nuvei-card	Nuvei
planet-card	Planet
razorpay-card	Razorpay
stripe-card	Stripe
trustpayments-card	Trust Payments
usaepay-card	USAePay
worldpayvap-card	Worldpay (VAP)

Bank

Coming soon.

Wallets

Coming soon.

Connection Formula Details

On-boarding a new connection onto the Basis Theory Managed Connections is as easy as an API call, although that may not be the last step to ensure connectivity between Basis Theory and your new Connection. The following are a set of guides that outline additional steps required to on-board specific Connections.

Adyen Card

Account Setup

Adyen provides a self-service sign-up for a sandbox account; navigate to the sign-up page to get started.

Credentials Setup

1. Open the Adyen dashboard and navigate to Developers -> API credentials in the left-hand sidebar.
2. Create a set of credentials. You must create a Web Service key and give it a name. We recommend setting a descriptive name for the key, e.g. Basis Theory.
3. Request access from Adyen to add the API PCI Payments role on the credential created in step 2. (Find more information from Adyen)
4. You'll now use this credential into the Basis Theory Connection configuration.

Connection Setup Values

• A server-side API key is the key we will use to authenticate with the Adyen API.
  • This key can be found on the credentials page under Server Settings -> Authentication -> API key.
• A merchant account is the public ID of your account used when connecting to Adyen.
  • You can find this in your dashboard under Settings -> Account settings -> Merchant overview -> Name.

Additional Account Settings

To ensure connectivity for all of the card services, you’ll need to provide the following settings enabled for your Adyen account:

Go to Developers -> Additional data in the Adyen dashboard and ensure the following fields are selected.

• Recurring Details
• Raw acquirer result
• Payment account reference