WireBloomDevelopers

    BankingCircleConnectionConfig

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

    • baseUrl string (uri)required

      https URL of the provider API (host is checked against the adapter allow-list)

      max length 2048

    • authUrl string (uri)required

      https URL of the provider API (host is checked against the adapter allow-list)

      max length 2048

    • companyId stringrequired

      min length 1 · max length 64

    • companyNumber stringrequired

      pattern ^\d{9}$

    • bic string

      pattern ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$ · default "SXPYDKKKXXX"

    • masterAccounts array of objectrequired

      Fields of masterAccounts

      • currency stringrequired

        One of: "AED", "AUD", "BGN", "BHD", "BIF", "BRL", "CAD", "CHF", "CLF", "CLP", "CNH", "CNY", "CZK", "DJF", "DKK", "EGP", "EUR", "GBP", "GEL", "GNF", "HKD", "HUF", "IDR", "ILS", "INR", "IQD", "ISK", "JOD", "JPY", "KES", "KMF", "KRW", "KWD", "LYD", "MAD", "MXN", "MYR", "NGN", "NOK", "NZD" and 25 more

      • accountId stringrequired

        min length 1 · max length 64

      • iban string

        max length 34

      • accountNumber string

        pattern ^\d{6,20}$

      • validForVirtualAccount boolean

        default false

      • protectionType string

        One of: "None", "ClientMoney", "SafeGuarded"

    • fxSettlementAccounts array of object

      Fields of fxSettlementAccounts

      • currency stringrequired

        One of: "AED", "AUD", "BGN", "BHD", "BIF", "BRL", "CAD", "CHF", "CLF", "CLP", "CNH", "CNY", "CZK", "DJF", "DKK", "EGP", "EUR", "GBP", "GEL", "GNF", "HKD", "HUF", "IDR", "ILS", "INR", "IQD", "ISK", "JOD", "JPY", "KES", "KMF", "KRW", "KWD", "LYD", "MAD", "MXN", "MYR", "NGN", "NOK", "NZD" and 25 more

      • accountId stringrequired

        min length 1 · max length 64

    • rails array of stringrequired

    • vibanPolicy object

      Fields of vibanPolicy

      • orderType stringrequired

        One of: "Reconciliation", "Pobo", "Cobo"

      • poolSize integer

        min 0 · max 100000 · default 0

      • pool array of string

      • replenishBatch integer

        min 1 · max 2500 · default 50

      • defaultPhysicalAccountId string

        min length 1 · max length 64

      • countryFormats array of string

    • webhookSubscriptions array of object

      Fields of webhookSubscriptions

      • subscriptionId stringrequired

        min length 1 · max length 64

      • events array of string

      • mtlsEnabled boolean

        default false

    • webhookKeyEncoding string

      One of: "utf8", "base64"

      default "utf8"

    • certificate object

      Fields of certificate

      • thumbprint stringrequired

        pattern ^[0-9A-Fa-f]{40}$

      • expiresAt string (date-time)required

        pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

    • directDebits boolean

      default false

    • directDebitCreditor object

      Fields of directDebitCreditor

      • name stringrequired

        min length 1 · max length 70

      • creditorId stringrequired

        pattern ^[A-Z]{2}\d{2}[A-Z0-9]{1,31}$

      • country stringrequired

        pattern ^[A-Z]{2}$

      • townName string

        min length 1 · max length 35

    • heldRates boolean

      default true

    • accountHolderVerification boolean

      default true

    • ahvPoll object

      Fields of ahvPoll

      • attempts integer

        min 1 · max 20 · default 5

      • intervalMs integer

        min 0 · max 10000 · default 1000

    • reconcile object

      Fields of reconcile

      • statementDays integer

        min 1 · max 31 · default 1

      • pageSize integer

        min 10 · max 5000 · default 500

      • source string

        One of: "reconciliation_report", "statement"

        default "reconciliation_report"

    • transactionsWindowDays integer

      min 1 · max 180 · default 30

    • truncate boolean

      default false

    • inboundIpAllowList array of string (cidrv4) | string (cidrv6)