Skip to main content
PATCH
Update a Connection
Partially updates a connection you previously created. Only the fields present in the body are applied — anything you omit keeps its current value.
What you can’t change here: provider_id, flow_type, payment_methods and the INTEGRATION_TYPE param are immutable. To change any of them, create a new connection and repoint your routing rules at it.

Path Parameters

string
required
The id returned by Create a Connection. Must belong to the account your API key is scoped to.

Body

string
required
UUID of the account the connection belongs to.
string
New label for this connection. Max 255 characters, and must still be unique within the account. Omit it to keep the current label.
object[]
Params to change, as a flat array of {param_id, value} pairs — the same shape as Create a Connection.Params are merged by param_id over the connection’s current params: a param_id you don’t send keeps its current value. You only need to send what you’re actually changing. Every param_id you do send is validated against the provider catalog.
object[]
Cost configuration. Unlike params, costs is not merged — when present it replaces the connection’s entire cost table. Omit it to leave the existing costs untouched.

Response

Returns the refreshed connection, in the same shape as Retrieve a Connection.
string
Unique identifier for the connection. Unchanged by an update.
string
Your internal label for this connection.
string
The provider this connection belongs to.
string
Current status.
string
Always PAYIN.
string[]
List of supported payment methods.
object[]
The connection’s full param set after the merge — not just the ones you sent. Sensitive values are masked as ***.
object[]
Cost configuration for the connection.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp. Bumped by a successful update.
Secret handling: params marked secret: true in the catalog are always returned as "value": "***". Sending "***" back is not how you keep a secret — just omit the param_id entirely and its stored value is preserved.

Errors

Authorizations

PUBLIC-API-KEY
string
header
default:<Your PUBLIC-API-KEY>
required
PRIVATE-SECRET-KEY
string
header
default:<Your PRIVATE-SECRET-KEY>
required

Path Parameters

connection_id
string<uuid>
required

Body

application/json
account_id
string<uuid>
required
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

merchant_connection_id
string
Maximum string length: 255
Example:

"stripe-us-prod-002"

params
object[]
costs
object[]

Response

OK

connection_id
string
Example:

"f1a3c4d5-7b8e-4a2c-9d1e-3f4a5b6c7d8e"

merchant_connection_id
string
Example:

"stripe-us-prod-002"

provider_id
string
Example:

"STRIPE"

status
string
Example:

"ACTIVE"

flow_type
string
Example:

"PAYIN"

payment_methods
string[]
Example:
params
object[]
costs
object[]
created_at
string<date-time>
Example:

"2026-05-12T10:24:00Z"

updated_at
string<date-time>
Example:

"2026-05-12T11:02:17Z"