The identity and technical contract details declared by the specification.
ISecureDsErrorResponse
object
1 property
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
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
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
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
PassiveDepositAddressListItem
object
7 properties
7 required
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
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
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
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
ISubscriptionStringCustomer
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
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
DelegatedPayoutResponse
object
2 properties
2 required
EnhancedTxInfoIpLocation
object
10 properties
7 required
Merchant_RefundPayment_Response_200
WithdrawReviewStatus
string
RefundTotals
object
6 properties
5 required
UserWithdrawTransactionParams
object
6 properties
6 required
IMerchantUser
object
8 properties
2 required
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
JobStatusResponseOneOf1Status
string
WithdrawFailedReturnStatus
string
IPaymentCardInfo
object
18 properties
3 required
CustomerVerificationSetting
string
InterchangeFees
object
2 properties
1 required
WithdrawFeeConfig
object
5 properties
3 required
IVenmoPaymentInfoSandboxSimulations
object
3 properties
SupportedChainToken
object
3 properties
3 required
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
JobStatusResponseOneOf0Status
string
UboEntry
object
9 properties
3 required
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
WebhookDisplay
object
11 properties
9 required
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
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
Blockchain.STELLAR
string
Merchant_GetPayoutBalance_Response_200
object
1 property
1 required
Partial_WithdrawLimit_
object
Make all properties in T optional
3 properties
Merchant_GetWithdrawal_Response_200
object
1 property
1 required
PayoutProviderOption
string
IPaymentCryptoInfo
object
20 properties
1 required
PassiveDepositAddressStatusResponse
object
2 properties
2 required
ICustomerWallet
object
From T, pick a set of properties whose keys are in the union K
20 properties
9 required
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
PassiveDepositAddressListResponse
object
1 property
1 required
IChargebackUpdate
object
4 properties
4 required
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
Merchant_SettlePayment_Response_200
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
VenmoSettings
object
10 properties
5 required
CreateCryptoWithdrawBody
object
4 properties
4 required
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
JobStatusResponseOneOf2Status
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
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
IPopulatedCard
object
10 properties
8 required
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
CustomPayInFeesConfig
array
ReimbursementStatus
string
Partial_Record_Blockchain.boolean__
object
Make all properties in T optional
9 properties
IbanSettings
object
9 properties
2 required
LinkedBankAccountAccountType
string
ISecureDS
object
14 properties
8 required
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
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
IMerchantStringRiskControls
object
1 property
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
IMerchantStringWalletsEvm
object
2 properties
2 required
CustomerUsdcTransferDataValidAfter
ICashAppPaymentInfo
object
7 properties
5 required
VenmoPayoutProvider
string
IPaymentStringIbanInfo
object
12 properties
4 required
IPayment_string_
object
45 properties
7 required
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
EnhancedTxInfoResponseIpLocation
object
10 properties
7 required
VendorSettings
object
8 properties
MarketplaceInfo
object
5 properties
GetSupportedChainsResponse
object
1 property
1 required
ISubscriptionPlanStringMerchant
IPaymentStringBankTransferInfo
object
8 properties
3 required
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
IPaymentIbanInfo
object
12 properties
4 required
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
ProgramWhitelistStatus
string
PayPalPaymentStatus
string
JobStatusResponse0
object
1 property
1 required
FraudReport
object
3 properties
2 required
MerchantCreditsMintPostResponsesContentApplicationJsonSchemaJobId
OrchestrationTraversalStep
object
4 properties
2 required
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
VendorSettingsKoard
object
4 properties
1 required
MerchantPaymentsAchReturnsGetParametersSortBy
string
StoredCardTransactionType
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
DirectVendorSettlement
string
WithdrawWithDescriptiveStatusMerchant
CashAppSettings
object
8 properties
2 required
WebhookSettings
object
5 properties
3 required
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
RefundWebhookData
object
9 properties
5 required
InteracPayoutProvider
string
ExportDownloadResponse
object
2 properties
2 required
CustomerUsdcTransferDataV2ValidBefore
IPaymentStringRefundInfo
object
3 properties
3 required
DelegatedPayoutQuote
object
17 properties
15 required
IWithdrawManualSuccessAudit
object
4 properties
4 required
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
IRefund
object
23 properties
13 required
IInteracPaymentInfo
object
10 properties
5 required
IAvailability
object
4 properties
4 required
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
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
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Coinflow publishes across the network.