Connections

Enterprise

Create Connection

Creates a new connections based on a Connection Formula, once created a connection is available for use in transactions.

POST

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

Permissions

orchestration:connections:create

Request

Terraform

module "basistheory_orchestration_connection" "example_connection" {
  connection_formula_id = "stripe"
  method                = "card"
  display_name          = "Stripe (Production)"
  accepted_countries    = ["US", "GB", "DE"]
  accepted_currencies   = ["EUR", "USD", "GBP"]
  active                = true

  fields = [
    {
      key   = "private_key"
      value = "sk_test_26PHem9A..."
    }
    // All required fields for the connection formula
  ]
}

cURL

curl "https://api.basistheory.com/orchestration/connections" \
  -H "BT-API-KEY: <PRIVATE_API_KEY>"
    -d '{
      "connection_formula_id": "stripe",
      "method": "card",
      "display_name": "Stripe (Production)",
      "fields": [
        {
          "key": "private_key",
          "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
        }
      ],
      "accepted_countries": [
        "US",
        "GB",
        "DE"
      ],
      "accepted_currencies": [
      "EUR",
      "USD",
      "GBP"
      ],
      "active": true,
      }'

Request Parameters

Parameter	Required	Type	Default	Description
connection_formula_id	true	string		The connection formula to use to create the connection
method	true	string		Type of connection.
display_name	true	string		Name to identify the connection.
fields	true	array		Fields needed to meet the requirements of the connection formula
accepted_countries	true	array		Countries to support with connection
accepted_currencies	true	array		Currencies to support with connection
active	true	boolean	true	Determines if the connection is usable for transactions.

Response

Returns a connection object if the connection was created. Returns an error if there were validation errors.

{
  "id": "faaad066-30b4-4997-a438-242b0752d7e1",
  "connection_formula_id": "stripe",
  "display_name": "Stripe (Production)",
  "status": "pending",
  "accepted_countries": [
    "US",
    "GB",
    "DE"
  ],
  "accepted_currencies": [
  "EUR",
  "USD",
  "GBP"
  ],
  "three_d_secure_enabled": true,
  "active": true
}

Delete Connection

DELETE

https://api.basistheory.com/orchestration/connections/{id}

Permissions

orchestration:connections:delete

Request

cURL

curl "https://api.basistheory.com/orchestration/connections/c06d0789-0a38-40be-b7cc-c28a718f76f1" \
  -H "BT-API-KEY: <API_KEY>" \
  -X "DELETE"

URL Parameters

Parameter	Required	Type	Description
connection_id	true	uuid	Existing connection id

Update Connection

PUT

https://api.basistheory.com/orchestration/connections/{id}

Permissions

orchestration:connections:update

Request

cURL

curl "https://api.basistheory.com/orchestration/connections/c06d0789-0a38-40be-b7cc-c28a718f76f1" \
-H "BT-API-KEY: <API_KEY>" \
-H "Content-Type: application/json" \
-X "POST" \
-d '{
  "connection_formula_id": "stripe",
  "method": "card",
  "display_name": "Stripe (Production)",
  "fields": [
{
  "key": "private_key",
  "value": "sk_test_26PHem9AhJZvU623DfE1x4sd"
}
  ],
  "accepted_countries": [
  "US",
  "GB",
  "DE"
  ],
  "accepted_currencies": [
  "EUR",
  "USD",
  "GBP"
  ],
  "active": true,
}'

URL Parameters

Parameter	Required	Type	Description
connection_id	true	uuid	Existing connection id

Request Parameters

Parameter	Required	Type	Default	Description
connection_formula_id	true	string		The connection formula to use to create the connection
method	true	string		Type of connection.
display_name	true	string		Name to identify the connection.
fields	true	array		Fields needed to meet the requirements of the connection formula
accepted_countries	true	array		Countries to support with connection
accepted_currencies	true	array		Currencies to support with connection
active	true	boolean	true	Determines if the connection is usable for transactions.

Response

{
  "id": "faaad066-30b4-4997-a438-242b0752d7e1",
  "connection_formula_id": "stripe",
  "display_name": "Stripe (Production)",
  "method": "card",
  "status": "pending",
  "accepted_countries": [
    "US",
    "GB",
    "DE"
  ],
  "accepted_currencies": [
  "EUR",
  "USD",
  "GBP"
  ],
  "three_d_secure_enabled": true,
  "active": true,
}

List Connections

PUT

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

Permissions

orchestration:connections:update

Request

cURL

curl "https://api.basistheory.com/orchestration/connections" -H "BT-API-KEY: <API_KEY>"

Response

[
  {
    "id": "faaad066-30b4-4997-a438-242b0752d7e1",
    "connection_formula_id": "stripe",
    "display_name": "Stripe (Production)",
    "method": "card",
    "status": "pending",
    "accepted_countries": [
      "US",
      "GB",
      "DE"
    ],
    "accepted_currencies": [
    "EUR",
    "USD",
    "GBP"
    ],
    "three_d_secure_enabled": true,
    "active": true,
  },
]

Resources

Connection Object

Parameter	Type	Description
id	string	Unique identifier for the connection
connection_formula_id	string	The connection formula to use to create the connection
display_name	string	Name to identify the connection.
fields	array	Fields needed to meet the requirements of the connection formula
accepted_countries	array	Countries to support with connection
accepted_currencies	array	Currencies to support with connection
active	boolean	Determines if the connection is usable for transactions.
status	enum	Returns if connection is available, failed, or pending
three_d_secure_enabled	boolean	Determines if 3D Secure is enabled for the connection