merchant
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.
post/merchant/settlement-address
Headers
Authorizationstring required
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
Request body
addressstring required
blockchain'solana' | 'eth' | 'polygon' | 'base' | 'user' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' required
Response
Ok
_idstring required
merchantIdstring required
urlstring
supportEmailstring
apiKeystring required
webhookValidationKeystring
nmiWebhookValidationKeystring
kycType'person' | 'business' | 'both' required
settlementToken'USDC' | 'SBC' | 'EUROe' | 'FXUSD' | 'HSUSD' | 'CFUSD' | 'YPUSD' required
hideBrandingboolean required
onlyShowTotalboolean required
skipSendWithdrawEmailboolean required
sendInvoiceNotificationsboolean required
invoiceFrequency'Monthly' | 'BiWeekly' | 'Weekly'
advancedAnalyticsboolean required
riskInsightsboolean required
Gates the Risk Insights dashboard. Admins see it regardless.
billingEmailsstring[]
pushToCardEnabledboolean required
requireAniCheckboolean required
bankPayoutProviderPayoutProviderOption[]
ibanPayoutProvidersIbanPayoutProvider[]
swiftPayoutProvidersSwiftPayoutProvider[]
ibanPayoutProvider'merge' | 'mock' | 'ivy'
rtpPayoutProvidersRtpPayoutProvider[]
rtpPayoutProvider'dwolla' | 'mock' | 'aptpay' | 'aptpayRtp' | 'checkbook' | 'brale'
pixPayoutProvidersPixPayoutProvider[]
pixPayoutProvider'brla' | 'mock'
eftPayoutProvidersEftPayoutProvider[]
eftPayoutProvider'checkbook' | 'aptpay' | 'mock'
p2cPayoutProvidersCardPayoutProvider[]
p2cPayoutProvider'aptpay' | 'checkbook' | 'shift4' | 'citcon' | 'MOCK'
globalP2cPayoutProvider'aptpay' | 'checkbook' | 'shift4' | 'citcon' | 'MOCK'
appleP2cPayoutProvider'aptpay' | 'MOCK'
venmoPayoutProvidersVenmoPayoutProvider[]
venmoPayoutProvider'checkbook' | 'citcon' | 'mock' | 'paypal'
paypalPayoutProvidersPayPalPayoutProvider[]
paypalPayoutProvider'checkbook' | 'citcon' | 'mock' | 'paypal'
wirePayoutProviderWirePayoutProvider[]
cryptoPayoutProvidersCryptoPayoutProvider[]
interacPayoutProvidersInteracPayoutProvider[]
interacPayoutProvider'checkbook' | 'mock' | 'aptpay'
interacPaymentProvider'mock' | 'aptpay'
withdrawRulesstring[]
parentstring
onboardingVersion'legacy' | 'sdd' | 'global'
childDefaultOnboardingVersion'legacy' | 'sdd' | 'global'
creditSeedstring required
withdrawSettlementLocation'circle' | 'brale' | 'paper' | 'brale_youpay' | 'bastion' required
enforceJwtboolean required
enforceCheckoutJwtboolean
externalVerificationLinksboolean
whitelistedAncestorUrlsstring[]
banDuplicateAccountsboolean
dealOwnerAdminIdstring
referralPartnerstring
signedMsaUrlstring
crmSyncedAtstring date-time
generatedDescriptionstring
allowAttestedKycboolean
attestedKycSsnNotRequiredboolean
allowAccountSharingboolean
personaKycShareTokenTemplatestring
delayedSettlementDaysnumber double required
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.
sendPresettleWebhooksboolean
enforceLivenessKycboolean
kycMinAgenumber double
canCreateBankAccountsboolean
globalRateLimitnumber double
banProxiesForCheckoutEndpointsboolean
acceptedToSboolean
chargebackFeeCentsnumber double
chargebackEmailsstring[]
fraudEmailsstring[]
sendExposureCapSlackAlertsboolean
mccstring