WireBloomDevelopers

    ProviderConnection

    Schema #/components/schemas/ProviderConnection of contract 1.0.0-draft.14.

    • id Uuidrequiredread-only

      Fields of id

      Uuid

    • operatorId Uuidrequiredread-only

      Fields of operatorId

      Uuid

    • customerId Uuid | null

    • provider ProviderIdrequired

    • environment ProviderEnvironmentrequired

    • name stringrequired

      max length 100

    • config ProviderConnectionConfigrequired

    • credentialsSet booleanrequiredread-only

      Whether credentials are stored. Credentials are never returned.

    • credentialsKid string | nullread-only

    • credentialsUpdatedAt Timestamp | null

    • credentialsFingerprint string | nullread-only

      Salted HMAC fingerprint (fp_ + 12 hex) so staff can tell credential sets apart without seeing them.

    • webhookSecretSet booleanread-only

    • webhookUrl string (uri)requiredread-only

      Register this URL with the provider.

    • status ConnectionLifecyclerequiredread-only

      Fields of status

      ConnectionLifecycle

    • role ConnectionRolerequiredread-only

      Fields of role

      ConnectionRole

    • fallbackCurrencies array of CurrencyCoderequiredread-only

      Currencies a fallback connection carries; empty for primaries.

    • contractModel ContractModel | nullrequired

    • webhookRegistrationState WebhookRegistrationStaterequiredread-only

      Fields of webhookRegistrationState

      WebhookRegistrationState

    • healthy boolean | nullread-only

      Health flag from the last health check (error is not a lifecycle state, D-32).

    • verifiedAt Timestamp | null

    • activatedAt Timestamp | null

    • drainingAt Timestamp | null

    • retiredAt Timestamp | null

    • capabilities objectread-only

      Fields of capabilities

      • virtualAccounts boolean

      • realAccounts boolean

      • sepa boolean

      • sepaInstant boolean

      • swift boolean

      • fasterPayments boolean

      • chaps boolean

      • bacs boolean

      • returns boolean

      • statementsCamt053 boolean

      • currencies array of CurrencyCode

      • fx boolean

      • forwards boolean

      • heldRates boolean

      • cards boolean

      • webhooks boolean

      • cop boolean

      • vop boolean

      • directDebit boolean

      • bulk boolean

      • recalls boolean

    • lastHealthAt Timestamp | null

    • lastHealth object | nullread-only

      Fields of lastHealth

      • ok boolean

      • latencyMs integer

      • message string | null

    • createdAt Timestamprequiredread-only

      Fields of createdAt

      Timestamp

    • updatedAt Timestampread-only

      Fields of updatedAt

      Timestamp