Skip to main content
GET
Retrieve a Connection
Returns a connection you previously created. Secrets are masked.

Path Parameters

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

Response

string
Unique identifier for the connection.
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[]
Echoed parameters. Sensitive values are masked as ***.
object[]
Cost configuration for the connection.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.

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

Response

OK

connection_id
string
Example:

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

merchant_connection_id
string
Example:

"stripe-us-prod-001"

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-12T10:24:00Z"