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
Allowed values:
settlementTokenenum
userslist of objects
uboslist of objects
goLiveChecklistobject
cardSettingsobject
achSettingsobject
wireSettingsobject
pixSettingsobject
ibanSettingsobject
cryptoPayinSettingsobject
cashAppSettingsobject
rainSettingsobject
nSureSettingsobject
hideBrandingboolean
onlyShowTotalboolean
skipSendWithdrawEmailboolean
sendInvoiceNotificationsboolean
requireAniCheckboolean
refundBalanceLimitobject
creditSeedstring
withdrawSettlementLocationenum
Allowed values:
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
brandobject
colorsobject
urlstring
customWithdrawFeesobject
Make all properties in T optional
customPayInFeeslist of objects
webhookValidationKeystring
nmiWebhookValidationKeystring
settlementAddressesobject
webhookSettingsobject
citconSettingsobject
aptPayCanadaSettingsobject
verisoulSettingsobject
blockConfigobject
billingEmailslist of strings
withdrawFeePaymentobject
bankPayoutProviderlist of enums
ibanPayoutProviderslist of enums
Allowed values:
ibanPayoutProviderenum
Allowed values:
rtpPayoutProviderslist of enums
rtpPayoutProviderenum
pixPayoutProviderslist of enums
Allowed values:
pixPayoutProviderenum
Allowed values:
eftPayoutProviderslist of enums
Allowed values:
eftPayoutProviderenum
Allowed values:
p2cPayoutProviderslist of enums
Allowed values:
p2cPayoutProviderenum
Allowed values:
globalP2cPayoutProviderenum
Allowed values:
appleP2cPayoutProviderenum
Allowed values:
venmoPayoutProviderslist of enums
Allowed values:
venmoPayoutProviderenum
Allowed values:
paypalPayoutProviderslist of enums
Allowed values:
paypalPayoutProviderenum
Allowed values:
wirePayoutProviderlist of enums
Allowed values:
interacPayoutProviderslist of enums
Allowed values:
interacPayoutProviderenum
Allowed values:
withdrawSortingobject
Make all properties in T optional
withdrawRuleslist of strings
maxTransactionAmountobject
minTransactionAmountobject
parentstring
enforceCheckoutJwtboolean
metakeepAppIdstring
whitelistedAncestorUrlslist of strings
banDuplicateAccountsboolean
ignoreCustomer10kDailyLimitboolean

Used to bypass the daily 10k limit per customer. This is specifically set for coinflow-invoice to true and shouldn’t be true for any other merchant. Not surfaced in settings

fxFeesobject
Make all properties in T optional
blockedobject
vendorSettingsobject
generatedDescriptionstring
bankSettlementOptionsobject
allowAttestedKycboolean
attestedKycSsnNotRequiredboolean
allowAccountSharingboolean
personaKycShareTokenTemplatestring
velocitySettingsobject
enforceLivenessKycboolean
canCreateBankAccountsboolean
checkbookSettingsobject
reserveSettingsobject
globalRateLimitdouble
banProxiesForCheckoutEndpointsboolean
riskControlsobject
acceptedToSboolean
ssoSettingsobject
chargebackFeeCentsdouble
chargebackEmailslist of strings
fraudEmailslist of strings
linkedBankAccountobject
firstPartyPayoutOverridesobjectDeprecated