merchant

Set Settlement Address

Changed on

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

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/merchant/settlement-address
  • Auth
    API key in header Authorization

Request body

addressstring required
blockchain'solana' | 'eth' | 'polygon' | 'base' | 'user' | 'arbitrum' | 'stellar' | 'monad' | 'tempo' required

Response

Ok

_idstring required
__vnumber double
merchantIdstring required
urlstring
supportEmailstring
tier'tier1' | 'tier2' | 'tier3'
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'avenia' | 'brla' | 'mock'
eftPayoutProvidersEftPayoutProvider[]
eftPayoutProvider'checkbook' | 'aptpay' | 'mock'
p2cPayoutProvidersCardPayoutProvider[]
p2cPayoutProvider'aptpay' | 'checkbook' | 'shift4' | 'citcon' | 'crb' | 'MOCK'
globalP2cPayoutProvider'aptpay' | 'checkbook' | 'shift4' | 'citcon' | 'crb' | '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
sendPresettleWebhooksboolean
enforceLivenessKycboolean
kycMinAgenumber double
canCreateBankAccountsboolean
globalRateLimitnumber double
banProxiesForCheckoutEndpointsboolean
acceptedToSboolean
chargebackFeeCentsnumber double
dailyStatementsEnabledboolean

Opt in to daily statements. Beta-gated per merchant rather than fleet-wide: wallet_movements sorts on tokenAccount and partitions by month, so a daily query prunes to the same partition a monthly one does and costs about the same — fleet-wide daily is ~30x today's warehouse load until a per-day rollup exists.

chargebackEmailsstring[]
fraudEmailsstring[]
sendExposureCapSlackAlertsboolean
disableForgotPasswordboolean
mccstring
experimentalTempoV2Creditsboolean

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status