Account Configuration
Account-level configuration holds the defaults every merchant under the account can inherit —
asset and wallet catalogs, checkout branding, network confirmation settings — plus the account's
billing fee schedule. Merchant-level overrides are managed via the Merchant
endpoints and their inherit/canSet flags.
Get Account Configuration
GET /accounts/{accountUUID}/config
curl --location '{API_BASE_URL}/accounts/{AccountUUID}/config' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json'
Get Account Configuration Response
Returns the full configuration object — every writable field from
Update Account Configuration plus the read-only fields managed
by Lydian: addressProvider, autoRefundConfig (automatic-refund switches for AML, fraud,
sanction, overpayment, and vendor-status triggers), defaultRecommendedNetwork,
processingFeeConfig, settlementAnchor, settlementFrequency,
subscriptionsEmailCustomerOnPaymentFailed, and subscriptionsEmailMerchantOnPaymentAttemptsExceeded.
- Name
allowedCrypto- Type
- array
- Description
Assets enabled for the account.
- Name
allowedWallets- Type
- array
- Description
Wallets shown at checkout.
- Name
allowedWalletsConfig- Type
- array
- Description
Per-wallet checkout presentation, each with
name,isFeatured,featuredNote, andorder.
- Name
checkoutConfig- Type
- object
- Description
Hosted checkout branding — same structure as on the Merchant endpoints (
logoURL,termNotice,theme,fonts,flow).
- Name
cryptoNetworkConfigs- Type
- object
- Description
Per-network, per-asset settings (
minConfirmsLow,minConfirmsHigh,qrExpirationSeconds).
- Name
highThreshold- Type
- number
- Description
High-value transaction threshold.
- Name
refundWindowHours- Type
- number
- Description
Window in which transactions can be refunded.
- Name
fees- Type
- object
- Description
Platform fee schedule (
lydian,partner) — same structure asfeeConfigon Update Merchant.
- Name
support- Type
- object
- Description
Support contact shown at checkout:
email,link.
- Name
settlementFrequency- Type
- string
- Description
Read-only. One of
hourly,six_hourly,daily,weekly,biweekly,monthly.
- Name
settlementAnchor- Type
- string
- Description
Read-only. Timestamp anchoring the settlement schedule.
example response
{
"allowedCrypto": ["USDT", "USDC"],
"allowedWallets": ["MetaMask", "Trust Wallet"],
"allowedWalletsConfig": [
{
"name": "MetaMask",
"isFeatured": true,
"featuredNote": "Recommended",
"order": 1
}
],
"checkoutConfig": {
"logoURL": "https://assets.lydian.com/merchants/brimspire/logo.png",
"termNotice": "",
"theme": {
"primaryColor": "#0A0A0A",
"accentColor": "#3B82F6",
"backgroundColor": "#FFFFFF",
"textColor": "#111111"
},
"fonts": { "family": "", "familyURL": "" },
"flow": {
"hideNoWalletOption": false,
"showApprovalPage": false,
"skipConfirmationPage": false
}
},
"cryptoNetworkConfigs": {
"ethereum": {
"cryptoAssetConfigs": {
"USDT": {
"minConfirmsLow": 1,
"minConfirmsHigh": 6,
"qrExpirationSeconds": 900
}
}
}
},
"highThreshold": 10000,
"refundWindowHours": 336,
"defaultRecommendedNetwork": "ethereum",
"settlementFrequency": "daily",
"settlementAnchor": "2025-01-01T00:00:00Z",
"support": {
"email": "support@brimspire.com",
"link": "https://brimspire.com/support"
},
"transactionFee": 0,
"transactionFeeRate": 0.01,
"settlementFee": 0,
"subscriptionsEmailCustomerOnPaymentFailed": true,
"subscriptionsEmailMerchantOnPaymentAttemptsExceeded": true
}
Update Account Configuration
Only the fields present in the request body are updated.
PUT /accounts/{accountUUID}/config
curl --location --request PUT '{API_BASE_URL}/accounts/{AccountUUID}/config' \
--header 'X-Api-Key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"allowedCrypto": ["{ASSET}"], // OPTIONAL
"allowedWallets": ["{WALLET_NAME}"], // OPTIONAL
"allowedWalletsConfig": [ // OPTIONAL — per-wallet checkout presentation
{
"name": "{WALLET_NAME}",
"isFeatured": {BOOL},
"featuredNote": "{NOTE_SHOWN_WHEN_FEATURED}",
"order": {SORT_ORDER}
}
],
"checkoutConfig": { // OPTIONAL — hosted checkout branding
"logoURL": "{LOGO_URL}",
"termNotice": "{TERMS_NOTICE_TEXT}",
"theme": {
"primaryColor": "{HEX_COLOR}",
"accentColor": "{HEX_COLOR}",
"backgroundColor": "{HEX_COLOR}",
"textColor": "{HEX_COLOR}"
},
"fonts": {
"family": "{FONT_FAMILY}",
"familyURL": "{FONT_URL}"
},
"flow": {
"hideNoWalletOption": {BOOL},
"showApprovalPage": {BOOL},
"skipConfirmationPage": {BOOL}
}
},
"cryptoNetworkConfigs": { // OPTIONAL
"{NETWORK_NAME}": {
"cryptoAssetConfigs": {
"{ASSET_NAME}": {
"minConfirmsLow": {MIN_CONFIRMS_LOW},
"minConfirmsHigh": {MIN_CONFIRMS_HIGH},
"qrExpirationSeconds": {QR_EXPIRATION_SECONDS}
}
}
}
},
"highThreshold": {HIGH_VALUE_THRESHOLD}, // OPTIONAL
"refundWindowHours": {HOURS}, // OPTIONAL
"support": { // OPTIONAL — support contact shown at checkout
"email": "{SUPPORT_EMAIL}",
"link": "{SUPPORT_URL}"
},
"fees": { // OPTIONAL — platform fee schedule
"lydian": {
"collection": "{deduct|bill_separately}",
"perTransaction": { "basisPoints": {BPS}, "flatCents": {CENTS} },
"perSettlement": { "basisPoints": {BPS}, "flatCents": {CENTS} },
"split": { "lydianShareBps": {BPS}, "partnerID": "{PARTNER_ID}" }
},
"partner": {
"customer": { "basisPoints": {BPS}, "flatCents": {CENTS} },
"mdr": { "basisPoints": {BPS}, "flatCents": {CENTS} }
}
},
"transactionFee": {FEE}, // OPTIONAL — billing schedule, see note below
"transactionFeeRate": {RATE}, // OPTIONAL
"settlementFee": {FEE}, // OPTIONAL
"authorizationFee": {FEE}, // OPTIONAL
"complianceFee": {FEE}, // OPTIONAL
"annualComplianceFee": {FEE}, // OPTIONAL
"complianceStartDate": "{DATE}", // OPTIONAL
"complianceEndDate": "{DATE}", // OPTIONAL
"oneTimeKYCFee": {FEE}, // OPTIONAL
"oneTimeEquipmentFee": {FEE}, // OPTIONAL
"oneTimeTerminationFee": {FEE}, // OPTIONAL
"oneTimeWeb3SecurityFee": {FEE}, // OPTIONAL
"monthlyProcessingFee": {FEE}, // OPTIONAL
"monthlyNonProcessingFee": {FEE}, // OPTIONAL
"monthlyAPIDataFee": {FEE}, // OPTIONAL
"monthlyDashboardFee": {FEE}, // OPTIONAL
"monthlyEquipmentFee": {FEE}, // OPTIONAL
"monthlyPremiumSupportFee": {FEE}, // OPTIONAL
"monthlyTerminalRentalFee": {FEE}, // OPTIONAL
"terminalLeaseFee": {FEE}, // OPTIONAL
"terminalLeaseStartDate": "{DATE}", // OPTIONAL
"terminalLeaseEndDate": "{DATE}", // OPTIONAL
"web3SecurityFee": {FEE}, // OPTIONAL
"web3SecurityStartDate": "{DATE}", // OPTIONAL
"web3SecurityEndDate": "{DATE}" // OPTIONAL
}'
The fee fields (transactionFee through web3SecurityEndDate) make up the account's billing
schedule, normally managed with your Lydian account manager. All fields are optional — omit
anything you don't want to change.
The response is the updated configuration — same structure as the Get Account Configuration Response.
