Coinflow withdraw API
The withdraw API from Coinflow — 30 operation(s) for withdraw.
Coinflow withdraw API is one of 14 APIs that Coinflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Withdraw. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 30 operations across 30 paths, and defines 290 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.
30 operations
30 paths
290 schemas
8 DELETE4 GET18 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 8
Coinflow withdraw 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-keyblockchain— The blockchain associated with the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-keyuserId— The external identifier of the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-keymerchant— The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-keysignedMessage— The message signed by the users walletmerchantId— The merchant ID the session should be generated forsessionKey— The session key generated for the end user - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
Paths & Operations 30
Across 30 paths, the API surfaces 30 operations — 8 DELETE, 4 GET, 18 POST. Each is listed below with its method, path, parameters, and response codes.
withdraw 30
POST
/withdraw/interac
Add Interac Account
POST
/withdraw/account
Create Bank Account
POST
/withdraw/account/v2
Create Bank Account (v2)
POST
/withdraw/debit-card
Create Debit Card
POST
/withdraw/eft
Create EFT Account
POST
/withdraw/iban
Create Iban Account
POST
/withdraw/pix
Create Pix Account
POST
/withdraw/transaction
Create Transactions
DELETE
/withdraw/account/{token}
Delete Withdrawer Bank Account
DELETE
/withdraw/card/{token}
Delete Withdrawer Card
DELETE
/withdraw/eft/{token}
Delete Withdrawer EFT Account
DELETE
/withdraw/iban/{token}
Delete Withdrawer Iban Account
DELETE
/withdraw/interac/{token}
Delete Withdrawer Interac Account
DELETE
/withdraw/paypal/{token}
Delete Withdrawer Paypal Account
DELETE
/withdraw/pix/{token}
Delete Withdrawer Pix Account
DELETE
/withdraw/venmo/{token}
Delete Withdrawer Venmo Account
GET
/withdraw/balances
Get Balances
POST
/withdraw/evm/message
Get Message (EVM USDC/SBC/EuroE only)
GET
/withdraw/quote
Get Quote
GET
/withdraw
Get Withdrawer
GET
/withdraw/history
Get Withdrawer History
POST
/withdraw/paypal
Link Paypal Account
POST
/withdraw/venmo
Link Venmo Account
POST
/withdraw/kyb
Register Business
POST
/withdraw/kyc
Register User
POST
/withdraw/kyc/attested
Register User Via Attested KYC
POST
/withdraw/kyc-doc
Register User Via Document
POST
/withdraw/kyc/share-token
Register User Via Share Token
POST
/withdraw/evm/transaction
Send Gasless Withdraw Transaction (EVM USDC/SBC/EuroE only)
POST
/withdraw/kyc/validate
Validate KYC Information
Schemas 290
The contract defines 290 schemas that model the data the API accepts and returns. The most detailed are Partial_Record_Currency.number__ (156 properties), IMerchant_string_ (115 properties), CardSettings (41 properties), IWithdraw (32 properties). Each schema is shown below with its type and property counts.
IPixAccount
object
3 properties
3 required
Withdraw_DeleteIbanAccount_Response_200
object
1 property
1 required
CardSettings
object
41 properties
5 required
NuveiV1MerchantArgs
object
3 properties
2 required
Withdraw_DeleteWithdrawerInterac_Response_200
object
1 property
1 required
PickIVenmoExcludeKeyofIVenmoVendorDataType
string
WithdrawQuoteFeesAndLimit
object
Represents the fees and limits associated with a withdrawal quote.
6 properties
4 required
WatchlistStatus
string
IBackwardUserMerchant
KycRequestBody
RainCompanyCardsSettings
object
12 properties
BlockedStatus
object
5 properties
4 required
ApaSettings
object
8 properties
2 required
InterchangeSettings
object
5 properties
5 required
VerificationStatus
string
UboEntry
object
9 properties
3 required
KybRequestBody
MerchantTheme
object
18 properties
ProgramWhitelistRequest
object
3 properties
3 required
AvailabilityStatus
string
ThreeDsChallengePreference
string
IWithdrawerWithAccountsMerchant
AptpayCanadaCoinflowSettings
object
1 property
1 required
MerchantScope
string
Verification
object
8 properties
3 required
PortalBrand
string
BlockingRuleMethod
string
ProgramWhitelistStatus
string
IUserLocation
object
End-user geographic coordinates captured at the moment of the withdrawal request. Consumed by BlockingRuleMethod.GEOLOCATION enforcement. Replay-of-different-c…
2 properties
2 required
AptpayCanadaMerchantSettings
object
1 property
1 required
ApplePayPaymentTokenPaymentDataHeader
object
3 properties
3 required
AddInteracArgs
object
3 properties
ApaProcessor
string
GetWithdrawTransactionRequestBodyAccount
One of: 1. The token of the bank account/card that the user is withdrawing to 2. An Apple Pay Response Object
Record_string.InterchangeRate_
object
Construct a type with a set of properties K of type T
WithdrawQuote
object
Represents a withdrawal quote with detailed information on fees and limits for different withdrawal speeds.
14 properties
12 required
Withdraw_DeleteWithdrawerAccount_Response_200
object
1 property
1 required
WithdrawSpeed
string
Withdraw_CreateKycShareToken_Response_200
object
1 property
1 required
GetWithdrawerResponse
object
1 property
1 required
ApplePayPayment
object
Apple Pay Payment received from the Apple Pay SDK Details can be found here: https://developer.apple.com/documentation/applepayontheweb/applepaypayment
4 properties
2 required
GetTransactionRequestUnavailableForLegalReasonsError
object
2 properties
2 required
IWithdrawerCardAccount
object
10 properties
5 required
ACHSettings
object
16 properties
4 required
Record_string.any_
object
Construct a type with a set of properties K of type T
Withdraw_DeleteEftAccount_Response_200
object
1 property
1 required
RainAutoTopUpCadence
string
IBackwardBusinessMerchant
Currency.GBP
string
Partial_Record_Currency.number__
object
Make all properties in T optional
156 properties
Country
string
CryptoPayInSettings
object
13 properties
8 required
IWithdrawMerchant
GetWithdrawTransactionRequestBody
object
10 properties
4 required
ReserveSettings
object
4 properties
3 required
RefundFeeSettings
object
4 properties
IMerchantStringWithdrawFeePayment
object
4 properties
BlockedLevel
string
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
CrbMerchantArgs
object
2 properties
AddDebitCardArgs
object
6 properties
3 required
CardSettingsApplePayCertificates
object
5 properties
5 required
AdditionalVerification
object
5 properties
4 required
GetWithdrawMessageBody
object
3 properties
1 required
KybPassiveRequestBody
object
5 properties
2 required
ApplePayIntegratorRegistration
object
4 properties
4 required
USState
string
CurrencyCents
object
2 properties
2 required
Pick_WithdrawToken.mint-or-decimals_
object
From T, pick a set of properties whose keys are in the union K
2 properties
2 required
ApplePayPaymentTokenPaymentData
object
An object containing the encrypted payment data.
4 properties
4 required
SettlementLocations
string
Withdraw_ValidateKyc_Response_200
object
2 properties
2 required
BankAccountType
string
Withdraw_DeletePixAccount_Response_200
object
1 property
1 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
PixSettings
object
8 properties
2 required
AftSettingsMerchantA2AMastercardAftRecipient
object
8 properties
8 required
RainPendingTopUp
object
3 properties
3 required
TopupRiskControls
object
2 properties
RainContractInfo
object
10 properties
5 required
CrbEnvironment
string
IWireProviderSettings
object
11 properties
2 required
MerchantGoLiveChecklist
object
7 properties
WithdrawCurrency
ApplePayPaymentTokenPaymentMethodType
string
A value representing the card's type of payment.
Withdraw_SendEvmGaslessTransaction_Response_200
object
1 property
1 required
Withdraw_DeleteWithdrawerPaypal_Response_200
object
1 property
1 required
Pick_ApplePayJS.ApplePayPaymentContact.emailAddress_
object
From T, pick a set of properties whose keys are in the union K
1 property
ApplePayPaymentTokenPaymentMethodNetwork1
string
Blockchain
string
CustomPayInFeesConfig
array
GetMessageResponse
object
1 property
1 required
Withdraw_DeleteWithdrawerVenmo_Response_200
object
1 property
1 required
VendorSettingsKoard
object
4 properties
1 required
CustomWithdrawFeeValue
Partial_Record_Blockchain.boolean__
object
Make all properties in T optional
9 properties
IMerchantStringProcessing
object
2 properties
2 required
IbanSettings
object
9 properties
2 required
Partial_WithdrawLimit_
object
Make all properties in T optional
3 properties
CardType
string
Withdraw_CreateKyc_Response_200
object
1 property
1 required
PaymentData
object
2 properties
1 required
WithdrawToken
object
8 properties
6 required
BankAccountConfirmationDetails
object
2 properties
PayoutProviderOption
string
WithdrawerVerificationRequiredResponse
object
6 properties
2 required
LinkedBankAccountAccountType
string
CustomPayInFeeValue
CitconSettings
object
2 properties
1 required
ReserveStatus
string
AddressOptionalState
object
6 properties
4 required
IBackwardBusiness
object
16 properties
13 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
PixProcessor
string
KybInformationBusiness
object
6 properties
5 required
Withdraw_CreateKycDocument_Response_200
object
1 property
1 required
CoinflowEntity
string
The Coinflow legal entity that owns a transaction. Used for compliance/finance's per-payment entity reporting (14259).
WireProcessor
string
WebhookVersion
string
AttestedKycRequest
object
10 properties
9 required
ApplePayPayoutProvider
string
Pick_IEftAccount.Exclude_keyofIEftAccount.vendorData__
object
From T, pick a set of properties whose keys are in the union K
10 properties
5 required
IMerchantStringSettlementAddressesRecipientAddressesItems
object
3 properties
2 required
PixPayoutProvider
string
KycShareTokenBody
SendEvmWithdrawTransactionBody
object
Make all properties in T required
9 properties
6 required
ApplePayPaymentToken
object
3 properties
3 required
IWithdrawUserPaidFees
object
5 properties
3 required
CustomFeePresentment
object
3 properties
3 required
KycPersonaShareTokenRequestBodyVendor
string
AcquirerInfo
object
4 properties
3 required
ApplePayPaymentTokenPaymentMethodNetwork
A string, suitable for display, that is the name of the payment network backing the card.
IAccountAddress
object
If address is not available on the user's KYC,the endpoint will return a 412 error and the request must be retried with the user's address information.
4 properties
4 required
LinkedBankAccount
object
6 properties
5 required
KybInformation
object
9 properties
5 required
IMerchantStringCheckbookSettings
object
5 properties
5 required
PayPalPayoutProvider
string
CustomPayInFeeValue1
object
4 properties
4 required
ValidateKycBody
object
5 properties
2 required
Partial_Record_WithdrawSpeed.WithdrawFeeConfig__
object
Make all properties in T optional
11 properties
AddBankAccountArgs
object
6 properties
4 required
ThreeDSArgs
object
Construct a type with a set of properties K of type T
7 properties
6 required
KycUserInformation
object
10 properties
10 required
VelocityControlSettings
object
5 properties
1 required
CustomPayInFeeConfig
object
2 properties
2 required
PaymentProcessor
string
IWithdrawManualFailAudit
object
4 properties
4 required
IMerchantStringBlockConfig
object
9 properties
Withdraw_CreateKycAttested_Response_200
object
1 property
1 required
PayPalSettings
object
10 properties
5 required
MerchantBankSettlementOptions
object
3 properties
2 required
IMerchantStringWithdrawFees
object
4 properties
4 required
MerchantBrandSettings
object
3 properties
TokenizationProviderOption
string
IWithdrawer
object
14 properties
10 required
ApplePayPaymentTokenPaymentMethod
object
Information about the card used in the transaction.
3 properties
3 required
IWithdrawWithdrawer
Pick_IPayPal.Exclude_keyofIPayPal.vendorData__
object
From T, pick a set of properties whose keys are in the union K
4 properties
3 required
FeePayerMode
string
KybInformationPerson
object
3 properties
3 required
PickIPayPalExcludeKeyofIPayPalVendorDataType
string
DirectVendorSettlement
string
IMerchantStringRiskControls
object
1 property
KycSumbsubShareTokenRequestBodyVendor
string
IWithdrawMerchantPaidFees
object
5 properties
3 required
KybPassiveRequestBodyAdditionalWalletsItems
object
2 properties
2 required
VenmoProcessor
string
IbanPayoutProvider
string
WebhookEventType
string
MerchantSsoSettings
object
1 property
1 required
Withdraw_GetWithdrawBalances_Response_200
object
1 property
1 required
IMerchant_string_
object
115 properties
36 required
EftPayoutProvider
string
BraidMerchantSettings
object
7 properties
5 required
CashAppSettings
object
8 properties
2 required
WebhookSettings
object
5 properties
3 required
EditorType
string
IUserStringMerchant
AddWithdrawMethodResponse
object
1 property
1 required
AddVenmoArgs
object
2 properties
1 required
IMerchantStringSettlementAddresses
object
13 properties
Pick_IInterac.Exclude_keyofIInterac.vendorData__
object
From T, pick a set of properties whose keys are in the union K
4 properties
3 required
BlockingRuleScope
string
CardPayoutProvider
string
IMerchantStringWalletsEvm
object
2 properties
2 required
KycType
string
WithdrawSort
string
InteracPayoutProvider
string
IMerchantStringWalletsSolana
object
2 properties
2 required
Partial_Record_WithdrawSpeed.WithdrawSort__
object
Make all properties in T optional
11 properties
AftPurpose
string
IWallet
object
2 properties
2 required
KycSumbsubShareTokenRequestBody
object
5 properties
4 required
Withdraw_CreateKyb_Response_200
object
1 property
1 required
VenmoSettings
object
10 properties
5 required
GreenlightMerchantArgs
object
2 properties
2 required
Withdraw_GetWithdrawerHistory_Response_200
object
1 property
1 required
VelocityLimitMode
string
IbanProcessor
string
InteracProcessor
string
IWithdrawManualSuccessAudit
object
4 properties
4 required
EvmTransferAuthorizationData
object
1 property
1 required
MerchantStyle
string
SsoProvider
string
IMerchantUser
object
8 properties
2 required
VerisoulRiskThresholds
object
12 properties
VenmoPayoutProvider
string
RtpPayoutProvider
string
IBusiness_string_
object
16 properties
12 required
EntityTag
object
1 property
1 required
Withdraw_DeleteWithdrawerCard_Response_200
object
1 property
1 required
IBusinessStringMerchant
GetWithdrawTransactionResponse
object
1 property
1 required
SendEvmWithdrawTransactionBodyAccount
One of: 1. The token of the bank account/card that the user is withdrawing to 2. An Apple Pay Response Object
WirePayoutProvider
string
CashAppProcessor
string
Currency.EUR
string
IAvailability
object
4 properties
4 required
Currency.USD
string
PayPalProcessor
string
AftType
string
RainCardApplicationStatus
string
IBackwardUser
object
18 properties
13 required
KycDocVRequestBody
object
4 properties
2 required
VendorSettings
object
8 properties
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
AddPaypalArgs
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
Currency.BRL
string
RainContractInfoOnramp
object
3 properties
AddDebitCardArgsAdditionalVendorData
object
Optional non-PCI passthrough fields merged into the stored card vendorData. Base type is empty; tokenization providers extend it with their own fields.
CustomWithdrawFeesConfig
object
Make all properties in T optional
14 properties
3 required
MerchantRfiRef
object
4 properties
3 required
WithdrawStatus
string
HighnoteMerchantSettings
object
4 properties
1 required
ApplePayBillingContact
object
10 properties
4 required
DwollaVerificationStatus
string
DisbursementStatus
string
AddBankAccountArgsType
string
IMerchantStringWalletsStellar
object
1 property
1 required
StableCoin
string
PayPalVendorSettings
object
7 properties
1 required
RfiStatus
string
CustomWithdrawFeeValue1
object
7 properties
6 required
AddBankAccountV2ArgsType
string
AddEftAccountArgs
object
8 properties
4 required
CustomWithdrawFeeValue0
object
7 properties
7 required
AftSettings
object
4 properties
3 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…
PassiveWithdrawSettings
object
Merchant-level settings for the withdrawer-side passive deposit address flow (CryptoWithdrawService). Independent from CryptoPayInSettings.
2 properties
1 required
IWithdrawerMerchant
AddBankAccountV2Args
object
9 properties
4 required
RainAccountDetails
object
6 properties
4 required
CustomPayInFeeValue0
object
4 properties
4 required
RainAutoTopUpSettings
object
6 properties
3 required
WithdrawFailedReturnStatus
string
InterchangeFees
object
2 properties
1 required
IMerchantStringFirstPartyPayoutOverrides
object
12 properties
CitconSettingsFundPurpose
string
AptPayCanadaSettings
WithdrawFeeConfig
object
5 properties
3 required
BlockingRuleListMode
string
GasFeeEstimate
object
Represents an estimate of gas fees for a transaction.
2 properties
2 required
KybDocVRequestBody
object
5 properties
3 required
DecryptedApplePayToken
object
7 properties
7 required
AchProcessor
string
IMerchantStringWallets
object
3 properties
3 required
KybDocVRequestBodyAdditionalWalletsItems
object
2 properties
2 required
UboInfo
object
9 properties
9 required
VerificationVendor
string
IbanAccountData
object
5 properties
1 required
Currency
string
IMerchantStringApiKeysItems
object
5 properties
3 required
Pick_IBankAccount.Exclude_keyofIBankAccount.vendorData-or-accountOwnerNames-or-nameMatchStatus__
object
From T, pick a set of properties whose keys are in the union K
9 properties
5 required
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
Currency.CAD
string
KycPersonaShareTokenRequestBody
object
3 properties
3 required
Cents
object
1 property
1 required
IWithdrawerWithAccounts
object
26 properties
20 required
CardOnFileSettings
object
7 properties
5 required
InteracSettings
object
8 properties
2 required
IUser_string_
object
18 properties
12 required
TierSettings
object
3 properties
2 required
IWithdraw
object
32 properties
17 required
VerisoulSettings
object
2 properties
2 required
DwollaWithdrawerInfo
object
4 properties
3 required
KycUsRequestBody
object
3 properties
1 required
PickIInteracExcludeKeyofIInteracVendorDataType
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Coinflow 12
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 merchant API
Coinflow merchantSubscription API
Coinflow redeem API
Coinflow refund API
Coinflow subMerchant API
Coinflow subscription API
#Withdraw
Where this information came from
This is an independent, third-party profile of Coinflow withdraw 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.