How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coinflow merchant API

The merchant API from Coinflow — 49 operation(s) for merchant.

Coinflow merchant API is one of 14 APIs that Coinflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Merchant. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 54 operations across 49 paths, and defines 461 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api-sandbox.coinflow.cash/api.

54 operations 49 paths 461 schemas 2 DELETE24 GET13 POST15 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.coinflow.cash/api
Authentication
API Key, API Key, API Key, API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 8

Coinflow merchant API declares 8 security schemes for authenticating requests. An API key is passed in the header as x-coinflow-auth-wallet (wallet). An API key is passed in the header as x-coinflow-auth-blockchain (blockchain). An API key is passed in the header as x-coinflow-auth-user-id (userId). An API key is passed in the header as Authorization (merchant). An API key is passed in the header as x-coinflow-auth-signed-message (signedMessage). An API key is passed in the header as x-coinflow-auth-merchant-id (merchantId). An API key is passed in the header as x-coinflow-auth-session-key (sessionKey). An API key is passed in the header as Authorization (admin).

  • wallet — The web3 wallet of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • blockchain — The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • userId — The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • merchant — The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
  • signedMessage — The message signed by the users wallet
  • merchantId — The merchant ID the session should be generated for
  • sessionKey — The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key

Paths & Operations 54

Across 49 paths, the API surfaces 54 operations — 2 DELETE, 24 GET, 13 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.

merchant 54
POST
/withdraw/crypto-deposit-address/activate
Activate Passive Deposit Address
activate-passive-deposit-address 1 param body → 200
PUT
/merchant/block-seller
Bans a seller
block-marketplace-seller 1 param body → 200
PUT
/merchant/blocked/{customerId}
Block or Unblock Customer
unblock-account 2 params body → 200
PUT
/merchant/block-withdrawer/{withdrawerId}
Block or Unblock Withdrawer
block-or-unblock-withdrawer 2 params body → 200
PUT
/merchant/{customerId}/exempt3DS
Configure 3DS exemption
update-3-ds-exemption 2 params body → 200
PUT
/merchant/{customerId}/attemptLimit
Configure attempt limit setting
update-attempt-limit-setting 2 params body → 200
POST
/merchant/chargebacks/{paymentId}/respond
Create Chargeback Response
respond 2 params body → 200
POST
/withdraw/crypto-deposit-address
Create Crypto Withdraw Deposit
create-crypto-withdraw-deposit 1 param body → 200
GET
/withdraw/crypto-deposit-address
Get Supported Chains
get-supported-chains 1 param → 200
POST
/merchant/exports
Create Export
create-export 1 param body → 200
GET
/merchant/exports
List Exports
list-exports 6 params → 200
POST
/withdraw/crypto-deposit-address/deactivate
Deactivate Passive Deposit Address
deactivate-passive-deposit-address 1 param body → 200
DELETE
/merchant/exports/{exportId}
Delete Export
delete-export 2 params → 200
GET
/merchant/exports/{exportId}
Get Export
get-export 2 params → 200
PUT
/merchant
Edit Merchant
edit-merchant 1 param body → 200
GET
/merchant
Get Merchant
get-merchant 1 param → 200
PUT
/merchant/payments/{paymentId}/fail
Fail Payment
fail-payment 2 params → 200
GET
/merchant/chargebacks
Get all chargebacks
get-all-chargebacks 16 params → 200
GET
/merchant/payments
Get All Payments
get-all-payments 14 params → 200
GET
/merchant/chargebacks/{paymentId}
Get chargeback data
get-chargeback 2 params → 200
GET
/merchant/chargebacks/{paymentId}/draft
Get Chargeback Response Draft
get-chargeback-response-draft 2 params → 200
PUT
/merchant/chargebacks/{paymentId}/draft
Save Chargeback Response Draft
save-draft-and-notes 2 params body → 200
GET
/merchant/chargebacks/rate
Get chargeback stats for time frame
get-chargeback-stats 3 params → 200
GET
/merchant/withdraws/payout/balance
Get Coinflow Wallet Balance
get-payout-balance 1 param → 200
GET
/merchant/customers
Get customer list
get-customer-accounts 8 params → 200
POST
/merchant/withdraws/payout/delegated/quote
Get Delegated Payout Quote
get-delegated-payout-quote 1 param body → 200
GET
/merchant/payments/enhanced/{paymentId}
Get Enhanced Transaction Information
get-enhanced-tx-information 2 params → 200
GET
/merchant/exports/{exportId}/download
Get Export Download URL
get-export-download-url 2 params → 200
GET
/merchant/credits/status/{jobId}
Get Job Status
get-job-status 2 params → 200
GET
/merchant/v2
Get Merchant
get-merchant-v-2 1 param → 200
GET
/merchant/payments/{paymentId}
Get Payment By ID
get-payment-by-id 2 params → 200
GET
/merchant/webhooks
Get Payment Webhook Activity
get-all-webhooks 10 params → 200
GET
/merchant/payments/ach-returns
Get Returned ACH Payments
get-ach-returns 10 params → 200
GET
/merchant/submerchants
Get Submerchants under Merchant
get-submerchants-for-merchant 1 param → 200
GET
/merchant/url-whitelist-requests
Get URL Whitelist Requests
get-url-whitelist-requests 1 param → 200
GET
/merchant/withdraws/{withdrawalId}
Get Withdrawal
get-withdrawal 2 params → 200404
GET
/merchant/withdraws
Get Withdraws
get-all-withdraws 12 params → 200
GET
/merchant/withdrawers
Gets merchant withdrawers
get-withdrawers 3 params → 200
GET
/withdraw/crypto-deposit-address/passive
List Passive Deposit Addresses
list-passive-deposit-addresses 1 param → 200
POST
/merchant/credits/mint
Mint Credits
mint-credits 1 param body → 200
PUT
/merchant/{customerId}/protection
Override Chargeback Protection
override-chargeback-protection 2 params body → 200
POST
/merchant/withdraws/payout/delegated
Payout to a user via Coinflow Wallet
payout-from-delegated-settlement-wallet 1 param body → 200402451503
POST
/merchant/withdraws/payout
Payout to a user via Merchant Self-Custodial Wallet
do-payout 1 param body → 200
PUT
/merchant/payments/{paymentId}/refund
Refund Payment
refund-payment 2 params body → 200
POST
/merchant/program
Request Program Approval
request-program-approval 1 param body → 200
POST
/merchant/url-whitelist-request
Request URL Whitelisting
request-url-whitelist 1 param body → 200
POST
/merchant/webhooks/{webhookLogId}
Resend Payment Webhook
resend-webhook 2 params → 200403404
DELETE
/merchant/url-whitelist
Revoke URL Whitelist
revoke-url-whitelist 1 param body → 200
PUT
/merchant/{customerId}/override-limit
Set Customer Override Limit
set-customer-override-limit 2 params body → 200
POST
/merchant/settlement-address
Set Settlement Address
set-settlement-address 1 param body → 200
PUT
/merchant/payments/{paymentId}/settle
Settle Payment
settle-payment 2 params → 200
PUT
/merchant/unverify-seller
Unverify Seller
unverify-seller 1 param body → 200
PUT
/merchant/withdraws/custom-fees
Update Custom Withdrawal Fees
update-custom-withdrawal-fees 1 param body → 200
PUT
/merchant/chargebacks/{paymentId}/ignore
Update merchant ignore chargeback
update-chargeback-ignore-status 2 params body → 200

Schemas 461

The contract defines 461 schemas that model the data the API accepts and returns. The most detailed are Partial_Record_Currency.number__ (156 properties), IMerchant_string_ (115 properties), IPayment (45 properties), IPayment_string_ (45 properties). Each schema is shown below with its type and property counts.

Blockchain.SOLANA
string
ISecureDsErrorResponse
object
1 property
WebhookData
Blockchain.TEMPO
string
RainCompanyCardsSettings
object
12 properties
BlockedStatus
object
5 properties 4 required
ApaSettings
object
8 properties 2 required
Blockchain.POLYGON
string
AptpayCanadaCoinflowSettings
object
1 property 1 required
ApaPaymentStatus
string
Merchant_GetMerchantV2_Response_200
object
3 properties 1 required
IChargeback
object
21 properties 8 required
IPayment
object
45 properties 7 required
PayoutDelegatedArgs
object
From T, pick a set of properties whose keys are in the union K
6 properties 5 required
Record_string.InterchangeRate_
object
Construct a type with a set of properties K of type T
ExportFilters
object
13 properties
DisbursedFundsWebhookData
object
7 properties 5 required
CryptoPaymentStatus
string
RainAutoTopUpCadence
string
IWithdrawMerchant
BlockedLevel
string
IMerchantStringWithdrawFeePayment
object
4 properties
Pick_IVenmo.Exclude_keyofIVenmo.vendorData__
object
From T, pick a set of properties whose keys are in the union K
4 properties 3 required
IvySettings
object
2 properties 2 required
IPayPalPaymentInfo
object
7 properties 3 required
AdditionalVerification
object
5 properties 4 required
CryptoTiers
string
CurrencyCents
object
2 properties 2 required
PayoutFromDelegatedSettlementWalletRequestUnavailableForLegalReasonsError
object
2 properties 2 required
Pick_WebhookSettings.Exclude_keyofWebhookSettings.webhookUrls__
object
From T, pick a set of properties whose keys are in the union K
4 properties 2 required
SettlementLocations
string
AllChargebackResponse
object
From T, pick a set of properties whose keys are in the union K
23 properties 12 required
PixSettings
object
8 properties 2 required
CustomerOverrideLimitWebhookData
object
6 properties 6 required
WithdrawCurrency
PassiveDepositAddressListItem
object
7 properties 7 required
Blockchain.ETH
string
NameMatchStatus
string
The accountNumber is the encrypted accountNumber The accountNumberOnlyHash is computed off the accountnumber in the secure vault - this could differ because ba…
IPopulatedSubscriptionStringMerchant
IMerchantStringProcessing
object
2 properties 2 required
CitconSettings
object
2 properties 1 required
RefundDenominationType
string
IExport
object
21 properties 11 required
ICleanPurseCardsItems
object
From T, pick a set of properties whose keys are in the union K
9 properties 5 required
PaymentWebhookData
object
28 properties 9 required
WithdrawWebhookData
object
15 properties 11 required
WithdrawStatusWithReview
PixPayoutProvider
string
ChallengeState
string
JobStatusResponse2
object
2 properties 2 required
ExportProgress
object
2 properties 1 required
ICleanPurse
object
8 properties 6 required
LinkedBankAccount
object
6 properties 5 required
ICleanPurseAccountsItems
object
From T, pick a set of properties whose keys are in the union K
16 properties 8 required
IMerchantStringCheckbookSettings
object
5 properties 5 required
IPaymentRefundInfo
object
3 properties 3 required
IRefundCustomer
Pick_MarketplaceInfo.fixedFee-or-feePercentage_
object
From T, pick a set of properties whose keys are in the union K
2 properties
VelocityControlSettings
object
5 properties 1 required
PaymentProcessor
string
IMerchantStringBlockConfig
object
9 properties
UAParser.IOS
object
2 properties
PayoutDelegatedArgsAmount
object
2 properties 1 required
PayPalSettings
object
10 properties 5 required
MerchantBankSettlementOptions
object
3 properties 2 required
IWithdrawer
object
14 properties 10 required
CustomerInfo
RefundMethod
string
ISubscriptionStringCustomer
FeePayerMode
string
AVSResponseCode
string
AVS (Address Verification System) Response Codes These codes indicate the results of address verification checks
Merchant_GetChargeback_Response_200
object
3 properties 3 required
IbanPayoutProvider
string
IPaymentStringPixInfo
object
7 properties 3 required
WithdrawWithDescriptiveStatusWithdrawer
IMerchant_string_
object
115 properties 36 required
VenmoPaymentStatus
string
CryptoWithdrawDepositResponse
object
6 properties 6 required
MerchantEditor
object
3 properties 3 required
SettledWebhookData
object
34 properties 10 required
IVenmoPaymentInfo
object
7 properties 3 required
CustomerUsdcTransferDataV2ValidAfter
FailedIbanAttempt
object
3 properties 3 required
SubscriptionStatus
string
IWallet
object
2 properties 2 required
AftPurpose
string
IMerchantStringWalletsSolana
object
2 properties 2 required
Partial_Record_WithdrawSpeed.WithdrawSort__
object
Make all properties in T optional
11 properties
GreenlightMerchantArgs
object
2 properties 2 required
IbanProcessor
string
Blockchain.MONAD
string
DelegatedPayoutResponse
object
2 properties 2 required
EnhancedTxInfoIpLocation
object
10 properties 7 required
Merchant_RefundPayment_Response_200
WithdrawReviewStatus
string
WebhookDisplayData
RefundTotals
object
6 properties 5 required
UserWithdrawTransactionParams
object
6 properties 6 required
IMerchantUser
object
8 properties 2 required
IExportMerchant
IBusinessStringMerchant
WirePayoutProvider
string
CryptoPayinFundsReceivedWebhookData
object
12 properties 12 required
CardSettingsVerificationSettings
object
2 properties
CrbMerchantSettings
object
The merchant's CRB banking identity. CRB is onboarded manually in CRB's dashboard — these values are pasted into our merchant dashboard and verified live again…
4 properties 1 required
UAParser.IDevice
object
3 properties
IGeoBlockOverride
object
Per-customer exemption from real-time geographic enforcement. When set and not expired, withdrawal blocking rules with method GEOLOCATION or IP are skipped for…
4 properties 3 required
PayPalVendorSettings
object
7 properties 1 required
RfiStatus
string
IWithdrawerMerchant
JobStatusResponseOneOf1Status
string
WithdrawFailedReturnStatus
string
IPaymentCardInfo
object
18 properties 3 required
CustomerVerificationSetting
string
WirePaymentStatus
string
InterchangeFees
object
2 properties 1 required
WithdrawFeeConfig
object
5 properties 3 required
AptPayCanadaSettings
IVenmoPaymentInfoSandboxSimulations
object
3 properties
SupportedChainToken
object
3 properties 3 required
KytAlertStatus
string
IPaymentStringMerchant
Currency
string
Cents
object
1 property 1 required
IUser_string_
object
18 properties 12 required
IWithdraw
object
32 properties 17 required
MerchantPutRequestBodyContentApplicationJsonSchemaSettlementAddresses
object
9 properties
CitconSettingsFundPurpose
string
UrlWhitelistStatus
string
AuthenticationStatus
string
PendingVerification
object
3 properties 1 required
PickIVenmoExcludeKeyofIVenmoVendorDataType
string
WithdrawQuoteFeesAndLimit
object
Represents the fees and limits associated with a withdrawal quote.
6 properties 4 required
WatchlistStatus
string
JobStatusResponseOneOf0Status
string
UboEntry
object
9 properties 3 required
IPaymentSubscription
CustomerOverrideAuditLog
object
5 properties 1 required
IPaymentUserLocation
object
Browser-captured geolocation at the time of the request, when the caller supplied one. Stored independently of payment method so the merchant dashboard can ren…
4 properties 2 required
Verification
object
8 properties 3 required
JobStatusResponse
WebhookDisplay
object
11 properties 9 required
ApaProcessor
string
Record_string.any_
object
Construct a type with a set of properties K of type T
OrchestrationTraversalStepNodeType
string
IApaPaymentInfo
object
10 properties 5 required
IPaymentStringCardInfo
object
18 properties 3 required
CryptoPayInSettings
object
13 properties 8 required
ReserveWebhookData
object
3 properties 3 required
DelegatedPayoutQuoteArgsAmount
object
2 properties 1 required
ReserveSettings
object
4 properties 3 required
RefundFeeSettings
object
4 properties
CardSettingsApplePayCertificates
object
5 properties 5 required
USState
string
WebhookPacketData
IBlockingRule
object
A single geo-blocking rule on a merchant. Multiple rules of the same scope are OR-combined: any matching rule blocks the request. When both DENY and ALLOW rule…
5 properties 3 required
TopupRiskControls
object
2 properties
CrbEnvironment
string
Blockchain.STELLAR
string
ICustomerStringMerchant
Merchant_GetPayoutBalance_Response_200
object
1 property 1 required
Partial_WithdrawLimit_
object
Make all properties in T optional
3 properties
CardType
string
Merchant_GetWithdrawal_Response_200
object
1 property 1 required
PayoutProviderOption
string
IPaymentCryptoInfo
object
20 properties 1 required
PassiveDepositAddressStatusResponse
object
2 properties 2 required
PixProcessor
string
ICustomerWallet
object
From T, pick a set of properties whose keys are in the union K
20 properties 9 required
ExportStatus
string
MobileWallet
string
CustomFeePresentment
object
3 properties 3 required
OrchestrationInfo
object
8 properties
IPaymentStringSubscription
Merchant_MintCredits_Response_200
object
1 property 1 required
PayPalPayoutProvider
string
ThreeDSArgs
object
Construct a type with a set of properties K of type T
7 properties 6 required
BinInfoCountry
PassiveDepositAddressListResponse
object
1 property 1 required
IChargebackUpdate
object
4 properties 4 required
IRefundMerchant
IWithdrawWithdrawer
IWirePaymentInfo
object
11 properties 5 required
Pick_IPayPal.Exclude_keyofIPayPal.vendorData__
object
From T, pick a set of properties whose keys are in the union K
4 properties 3 required
PickIPayPalExcludeKeyofIPayPalVendorDataType
string
ICustomer_string_
object
20 properties 9 required
IWithdrawMerchantPaidFees
object
5 properties 3 required
FailedAttemptSetting
string
VenmoProcessor
string
Merchant_SettlePayment_Response_200
EftPayoutProvider
string
WithdrawWithDescriptiveStatus
object
From T, pick a set of properties whose keys are in the union K
32 properties 17 required
IMerchantStringSettlementAddresses
object
13 properties
CardPayoutProvider
string
IPaymentStringDelayedSettlement
object
5 properties 4 required
Funding
string
Segment
string
VenmoSettings
object
10 properties 5 required
CreateCryptoWithdrawBody
object
4 properties 4 required
Blockchain.BASE
string
ReferenceKey
object
2 properties 2 required
ISubscription_string_
object
14 properties 9 required
VerisoulRiskThresholds
object
12 properties
KycWebhookData
object
3 properties 3 required
IBusiness_string_
object
16 properties 12 required
GetWithdrawTransactionResponse
object
1 property 1 required
ISecureDsErrorResponseThreeDSecureResponse
object
2 properties 2 required
PayPalProcessor
string
JobStatusResponseOneOf2Status
string
SettlementType
string
LiabilityOwner
string
Currency.BRL
string
WithdrawStatus
string
UAParser.IResult
object
6 properties 6 required
DwollaVerificationStatus
string
DisbursementStatus
string
CustomWithdrawFeeValue1
object
7 properties 6 required
UAParser.IEngine
object
2 properties
CustomWithdrawFeeValue0
object
7 properties 7 required
MpcWalletProvider
string
The MPC provider Coinflow uses to custody managed settlement wallets. Single source of truth — the merchant type, the predicate, and the query filter all refer…
Blockchain.ARBITRUM
string
IMerchantStringFirstPartyPayoutOverrides
object
12 properties
ICustomerWalletBlockConfigOverride
object
Per-customer overrides of merchant blockConfig. Only honored when they raise the effective limit.
1 property
SupportedChain
object
3 properties 3 required
WithdrawWithDescriptiveStatusMerchantPaidFees
object
5 properties 3 required
CreateExportRequest
object
3 properties 3 required
BlockSellerRequest
object
3 properties 3 required
TokenSubtotalAmount
Number of tokens
IMerchantStringApiKeysItems
object
5 properties 3 required
ISubscriptionPlan_string_
object
13 properties 7 required
ExchangeInfo
object
3 properties 2 required
MerchantRespondRequest1
object
1 property 1 required
MerchantWebhooksWebhookLogIdPostResponsesContentApplicationJsonSchemaJobId
Pick_ACHSettings.customerEmailNotifications-or-merchantEmailNotifications_
object
From T, pick a set of properties whose keys are in the union K
2 properties 2 required
MerchantCustomersGetParametersSortBy
string
AnyObject
object
1 property
IPixAccount
object
3 properties 3 required
IPaymentBankTransferInfo
object
8 properties 3 required
DelegatedPayoutQuoteArgs
object
From T, pick a set of properties whose keys are in the union K
4 properties 4 required
VerificationStatus
string
IPaymentStringVendorTransfer
object
2 properties 1 required
AvailabilityStatus
string
PaymentChargebackWebhookData
object
31 properties 13 required
JobStatusResponse1
object
2 properties 2 required
ThreeDsChallengePreference
string
PortalBrand
string
BlockingRuleMethod
string
AptpayCanadaMerchantSettings
object
1 property 1 required
OrchestrationFailedAttempt
object
3 properties 1 required
SubMerchantWebhookData
object
3 properties 2 required
Merchant_GetEnhancedTxInformation_Response_200
object
1 property 1 required
SubscriptionVersion
string
EnhancedTxInfo
object
19 properties
PaymentWebhookData3
object
From T, pick a set of properties whose keys are in the union K
28 properties 21 required
ACHSettings
object
16 properties 4 required
SanitizedUrlWhitelistRequest
object
6 properties 3 required
CustomerUsdcTransferData
object
Customer signed USDC transferWithAuthorization data for dual-source payments Used for combined USDC + Credit Card payments on EVM chains
9 properties 9 required
Currency.GBP
string
Country
string
IPopulatedCard
object
10 properties 8 required
ISecureDsCustomer
IPopulatedSubscription_string_
object
14 properties 9 required
MerchantPaymentsGetParametersSortBy
string
AftSettingsMerchantA2AMastercardAftRecipient
object
8 properties 8 required
SubscriptionWebhookData
object
10 properties 7 required
IWireProviderSettings
object
11 properties 2 required
WithdrawWithDescriptiveStatusUserPaidFees
object
5 properties 3 required
IChargebackPayment
IRefundPayment
CustomPayInFeesConfig
array
ReimbursementStatus
string
CustomWithdrawFeeValue
Partial_Record_Blockchain.boolean__
object
Make all properties in T optional
9 properties
IbanSettings
object
9 properties 2 required
LinkedBankAccountAccountType
string
ApaCredentialType
string
ReserveStatus
string
ISecureDS
object
14 properties 8 required
ICustomerWalletMerchant
PassiveDepositAddressStatusResponseStatus
string
CustomerData
object
6 properties 5 required
Pick_IIbanAccount.Exclude_keyofIIbanAccount.vendorData__
object
From T, pick a set of properties whose keys are in the union K
7 properties 6 required
WebhookPacket
object
4 properties 4 required
CoinflowEntity
string
The Coinflow legal entity that owns a transaction. Used for compliance/finance's per-payment entity reporting (14259).
Merchant_GetUrlWhitelistRequests_Response_200
object
1 property 1 required
ChargebackProtectionDecision
string
RefundSource
string
IMerchantStringSettlementAddressesRecipientAddressesItems
object
3 properties 2 required
BinInfo
object
5 properties 5 required
AcquirerInfo
object
4 properties 3 required
IPopulatedSubscriptionStringCustomer
MerchantWithdrawsGetParametersSortBy
string
IWithdrawManualFailAudit
object
4 properties 4 required
CreditOperation
object
4 properties 3 required
EnhancedTxInfoResponse
object
21 properties 2 required
ExportDownloadLog
object
4 properties 4 required
CardPaymentStatus
string
IMerchantStringRiskControls
object
1 property
WebhookEventType
string
PassiveDepositAddressBody
object
1 property 1 required
MerchantSsoSettings
object
1 property 1 required
BraidMerchantSettings
object
7 properties 5 required
Pick_CardSettings.customerEmailNotifications-or-merchantEmailNotifications_
object
From T, pick a set of properties whose keys are in the union K
2 properties 2 required
ISubscriptionStringPlan
IMerchantStringWalletsEvm
object
2 properties 2 required
WithdrawSort
string
VelocityLimitMode
string
CustomerUsdcTransferDataValidAfter
ICashAppPaymentInfo
object
7 properties 5 required
WebhookCategory
string
MerchantStyle
string
VenmoPayoutProvider
string
RtpPayoutProvider
string
IPaymentStringIbanInfo
object
12 properties 4 required
IPayment_string_
object
45 properties 7 required
CashAppProcessor
string
Currency.EUR
string
CustomerUsdcTransferDataV2
object
V2 of CustomerUsdcTransferData — replaces the (v, r, s) triple with a single signature bytes string, matching USDC FiatTokenV22's bytes-overload transferWithAu…
7 properties 7 required
Currency.USD
string
EnhancedTxInfoResponseIpLocation
object
10 properties 7 required
AftType
string
VendorSettings
object
8 properties
MarketplaceInfo
object
5 properties
GetSupportedChainsResponse
object
1 property 1 required
ISubscriptionPlanStringMerchant
IPaymentStringBankTransferInfo
object
8 properties 3 required
StableCoin
string
SubscriptionWebhookData3
object
From T, pick a set of properties whose keys are in the union K
10 properties 8 required
AftSettings
object
4 properties 3 required
PassiveWithdrawSettings
object
Merchant-level settings for the withdrawer-side passive deposit address flow (CryptoWithdrawService). Independent from CryptoPayInSettings.
2 properties 1 required
ISubscriptionStringMerchant
CustomPayInFeeValue0
object
4 properties 4 required
RainAutoTopUpSettings
object
6 properties 3 required
OverrideAuditLog
object
5 properties 1 required
NameCustomerInfo
object
13 properties
GasFeeEstimate
object
Represents an estimate of gas fees for a transaction.
2 properties 2 required
UAParser.ICPU
object
1 property
IMerchantStringWallets
object
3 properties 3 required
VerificationVendor
string
PixPaymentStatus
string
OverrideMethod
string
IPaymentIbanInfo
object
12 properties 4 required
IPaymentMerchant
OperationalBlockchain
Verification3DS
string
Merchant_ResendWebhook_Response_200
object
1 property 1 required
InteracSettings
object
8 properties 2 required
ChargebackStats
object
5 properties 5 required
IPaymentPixInfo
object
7 properties 3 required
CardSettings
object
41 properties 5 required
NuveiV1MerchantArgs
object
3 properties 2 required
Record_any.any_
object
Construct a type with a set of properties K of type T
SubscriptionInterval
string
InterchangeSettings
object
5 properties 5 required
MerchantTheme
object
18 properties
ProgramWhitelistRequest
object
3 properties 3 required
CashAppPaymentStatus
string
MerchantScope
string
ProgramWhitelistStatus
string
RefundStatus
string
PayPalPaymentStatus
string
JobStatusResponse0
object
1 property 1 required
FraudReport
object
3 properties 2 required
MerchantCreditsMintPostResponsesContentApplicationJsonSchemaJobId
OrchestrationTraversalStep
object
4 properties 2 required
WithdrawSpeed
string
Partial_Record_Currency.number__
object
Make all properties in T optional
156 properties
Pick_CryptoPayInSettings.customerEmailNotifications-or-merchantEmailNotifications_
object
From T, pick a set of properties whose keys are in the union K
2 properties 2 required
CrbMerchantArgs
object
2 properties
SplitNameCustomerInfo
object
14 properties 2 required
ApplePayIntegratorRegistration
object
4 properties 4 required
CryptoDepositFundsReceivedWebhookData
object
10 properties 10 required
RainPendingTopUp
object
3 properties 3 required
RainContractInfo
object
10 properties 5 required
MerchantGoLiveChecklist
object
7 properties
Blockchain
string
RefundReason
string
VendorSettingsKoard
object
4 properties 1 required
MerchantPaymentsAchReturnsGetParametersSortBy
string
CustomPayInFeeValue
WireProcessor
string
AchPaymentStatus
string
StoredCardTransactionType
string
WebhookVersion
string
ApplePayPayoutProvider
string
WithdrawWithDescriptiveStatusUserLocation
object
Browser-captured geolocation at the time of the withdraw request, when the caller supplied one. Stored independently of payout method so the merchant dashboard…
4 properties 2 required
IPaymentStringCryptoInfo
object
20 properties 1 required
IWithdrawUserPaidFees
object
5 properties 3 required
CVVResponseCode
string
CVV (Card Verification Value) Response Codes These codes indicate the results of CVV verification checks
PaymentDeclinedWebhookData3
object
From T, pick a set of properties whose keys are in the union K
33 properties 26 required
MerchantRespondRequest0
object
1 property 1 required
CustomPayInFeeValue1
object
4 properties 4 required
Partial_Record_WithdrawSpeed.WithdrawFeeConfig__
object
Make all properties in T optional
11 properties
CustomPayInFeeConfig
object
2 properties 2 required
InteracPaymentStatus
string
IMerchantStringWithdrawFees
object
4 properties 4 required
MerchantBrandSettings
object
3 properties
TokenizationProviderOption
string
ExportType
string
DirectVendorSettlement
string
WithdrawWithDescriptiveStatusMerchant
CashAppSettings
object
8 properties 2 required
WebhookSettings
object
5 properties 3 required
EditorType
string
IUserStringMerchant
BlockingRuleScope
string
WalletDebitStatus
string
PaymentChargebackWebhookData3
object
From T, pick a set of properties whose keys are in the union K
31 properties 25 required
PassiveDepositAddressListItemStatus
string
IPaymentDelayedSettlement
object
5 properties 4 required
OverrideMethod.CustomerOverride
string
KycType
string
RefundWebhookData
object
9 properties 5 required
InteracPayoutProvider
string
ExportDownloadResponse
object
2 properties 2 required
IbanPaymentStatus
string
InteracProcessor
string
CustomerUsdcTransferDataV2ValidBefore
IPaymentStringRefundInfo
object
3 properties 3 required
DelegatedPayoutQuote
object
17 properties 15 required
IWithdrawManualSuccessAudit
object
4 properties 4 required
SsoProvider
string
ExportFormat
string
ExchangeTotalsResponse
object
From T, pick a set of properties whose keys are in the union K
19 properties 2 required
EntityTag
object
1 property 1 required
Merchant_Respond_Request
IRefund
object
23 properties 13 required
IInteracPaymentInfo
object
10 properties 5 required
IAvailability
object
4 properties 4 required
IPaymentCustomer
PaymentDeclinedWebhookData
object
33 properties 11 required
RainCardApplicationStatus
string
TokenSubtotal
object
3 properties 2 required
RainContractInfoOnramp
object
3 properties
Record_string.string_
object
Construct a type with a set of properties K of type T
CustomWithdrawFeesConfig
object
Make all properties in T optional
14 properties 3 required
MerchantRfiRef
object
4 properties 3 required
HighnoteMerchantSettings
object
4 properties 1 required
IMerchantStringWalletsStellar
object
1 property 1 required
IPayPalPaymentInfoSandboxSimulations
object
3 properties
IPaymentStringCustomer
RainAccountDetails
object
6 properties 4 required
CustomerUsdcTransferDataValidBefore
BlockingRuleListMode
string
IPaymentVendorTransfer
object
2 properties 1 required
IPaymentStringUserLocation
object
Browser-captured geolocation at the time of the request, when the caller supplied one. Stored independently of payment method so the merchant dashboard can ren…
4 properties 2 required
UAParser.IBrowser
object
3 properties
AchProcessor
string
WebhookResponse
object
TotalsResponse
object
19 properties 6 required
CustomerOverrideLimitWebhookDataThresholdPercent
string
IWithdrawUserLocation
object
Browser-captured geolocation at the time of the withdraw request, when the caller supplied one. Stored independently of payout method so the merchant dashboard…
4 properties 2 required
SettledWebhookData3
object
From T, pick a set of properties whose keys are in the union K
35 properties 26 required
Currency.CAD
string
CryptoRefundInfo
object
7 properties 2 required
CardOnFileSettings
object
7 properties 5 required
DwollaWithdrawerInfo
object
4 properties 3 required
TierSettings
object
3 properties 2 required
VerisoulSettings
object
2 properties 2 required
IbanRfiWebhookData
object
12 properties 7 required
ICustomerStringBlockConfigOverride
object
Per-customer overrides of merchant blockConfig. Only honored when they raise the effective limit.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coinflow-merchant-api-openapi.yml Raw ↑

Other APIs Coinflow publishes across the network.

Coinflow authentication API
Coinflow cardTokenization API
Coinflow checkout API
Coinflow customers API
Coinflow events API
Coinflow marketplace API
Coinflow merchantSubscription API
Coinflow redeem API
Coinflow refund API
Coinflow subMerchant API
Coinflow subscription API
Coinflow utilities API
Where this information came from

This is an independent, third-party profile of Coinflow merchant API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.