Set Settlement Address

Set the blockchain account information which will be used for settlement. Only call this if you want the money processed from credit card transactions to be sent to directly as USDC to a company owned blockchain address.

Authentication

Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Request

This endpoint expects an object.
addressstringRequired
blockchainenumRequired

Response

Ok
_idstring
merchantIdstring
verificationobject
withdrawFeesobject
walletsobject
apiKeystring
apiKeyslist of objects
kycTypeenum
settlementTokenenum
userslist of objects
uboslist of objects
goLiveChecklistobject
cardSettingsobject
achSettingsobject
wireSettingsobject
pixSettingsobject
ibanSettingsobject
cryptoPayinSettingsobject
cashAppSettingsobject
paypalSettingsobject
venmoSettingsobject
apaSettingsobject
hideBrandingboolean
onlyShowTotalboolean
skipSendWithdrawEmailboolean
sendInvoiceNotificationsboolean
advancedAnalyticsboolean
riskInsightsboolean
Gates the Risk Insights dashboard. Admins see it regardless.
requireAniCheckboolean
interacSettingsobject
refundBalanceLimitobject
creditSeedstring
withdrawSettlementLocationenum
enforceJwtboolean
delayedSettlementDaysdouble

Number of business days to delay stablecoin settlement after payment capture. Only applies to USDC settlements. 0 means no delay (immediate settlement). Maximum value is 5 days.

interchangeFeesobject
pushToCardEnabledbooleanDeprecated
brandobjectOptional
colorsobjectOptional
urlstringOptional
supportEmailstringOptional
tierenum or nullOptional
customWithdrawFeesobjectOptional
Make all properties in T optional
customPayInFeeslist of objectsOptional
webhookValidationKeystringOptional
nmiWebhookValidationKeystringOptional
settlementAddressesobjectOptional
webhookSettingsobjectOptional
citconSettingsobjectOptional
aptPayCanadaSettingsobjectOptional
cryptoPayoutSettingsobjectOptional
Construct a type with a set of properties K of type T
passiveWithdrawSettingsobjectOptional

Merchant-level settings for the withdrawer-side passive deposit address flow (CryptoWithdrawService). Independent from CryptoPayInSettings.

rainCompanyCardsobjectOptional
verisoulSettingsobjectOptional
chargebackFightSettingsobjectOptional

Per-merchant chargeback-fight enrollment. This is the only per-merchant dimension of the shouldFight flag: when enabled is false (or the settings are absent) shouldFight is always false for that merchant. The actual match rules (processor + protection decision) live in the global {@link ChargebackFightRuleset }, configured by ops on the Chargeback Ops page.

blockConfigobjectOptional
invoiceFrequencyenumOptional
billingEmailslist of stringsOptional
withdrawFeePaymentobjectOptional
bankPayoutProviderlist of enumsOptional
ibanPayoutProviderslist of enumsOptional
swiftPayoutProviderslist of enumsOptional
ibanPayoutProviderenumOptional
rtpPayoutProviderslist of enumsOptional
rtpPayoutProviderenumOptional
pixPayoutProviderslist of enumsOptional
pixPayoutProviderenumOptional
eftPayoutProviderslist of enumsOptional
eftPayoutProviderenumOptional
p2cPayoutProviderslist of enumsOptional
p2cPayoutProviderenumOptional
globalP2cPayoutProviderenumOptional
appleP2cPayoutProviderenumOptional
venmoPayoutProviderslist of enumsOptional
venmoPayoutProviderenumOptional
paypalPayoutProviderslist of enumsOptional
paypalPayoutProviderenumOptional
wirePayoutProviderlist of enumsOptional
cryptoPayoutProviderslist of enumsOptional
interacPayoutProviderslist of enumsOptional
interacPayoutProviderenumOptional
interacPaymentProviderenumOptional
withdrawSortingobjectOptional
Make all properties in T optional
withdrawRuleslist of stringsOptional
maxTransactionAmountobjectOptional
minTransactionAmountobjectOptional
parentstringOptional
onboardingVersionenumOptional
childDefaultOnboardingVersionenum or nullOptional
enforceCheckoutJwtbooleanOptional
whitelistedAncestorUrlslist of stringsOptional
banDuplicateAccountsbooleanOptional
fxFeesobjectOptional
Make all properties in T optional
blockedobjectOptional
dealOwnerAdminIdstringOptional
referralPartnerstringOptional
signedMsaUrlstringOptional
crmSyncedAtdatetimeOptional
vendorSettingsobjectOptional
generatedDescriptionstringOptional
bankSettlementOptionsobjectOptional
allowAttestedKycbooleanOptional
attestedKycSsnNotRequiredbooleanOptional
allowAccountSharingbooleanOptional
personaKycShareTokenTemplatestringOptional
sendPresettleWebhooksbooleanOptional
velocitySettingsobjectOptional
velocitySettingsByRailobjectOptional
Make all properties in T optional
enforceLivenessKycbooleanOptional
kycMinAgedoubleOptional
canCreateBankAccountsbooleanOptional
checkbookSettingsobjectOptional
reserveSettingsobjectOptional
embeddedAccountSettingsobjectOptional
globalRateLimitdoubleOptional
banProxiesForCheckoutEndpointsbooleanOptional
riskControlsobjectOptional
acceptedToSbooleanOptional
ssoSettingsobjectOptional
chargebackFeeCentsdoubleOptional
chargebackEmailslist of stringsOptional
fraudEmailslist of stringsOptional
linkedBankAccountobjectOptional
customerDefaultOverrideLimitobjectOptional
customerOverrideLimitCeilingobjectOptional
customerDefaultExposureLimitobjectOptional
dailyExposureLimitobjectOptional
monthlyExposureLimitobjectOptional
sendExposureCapSlackAlertsbooleanOptional
mccstringOptional
processingobjectOptional
experimentalTempoV2CreditsbooleanOptional
firstPartyPayoutOverridesobjectOptionalDeprecated