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 customers API

The customers API from Coinflow — 15 operation(s) for customers.

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

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

This API exposes 15 operations across 15 paths, and defines 191 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.

15 operations 15 paths 191 schemas 6 DELETE4 GET5 POST

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 customers 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 15

Across 15 paths, the API surfaces 15 operations — 6 DELETE, 4 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

customers 15
POST
/customer/v2/bankAccount
Add Bank Account
add-bank-account 1 param body → 200
POST
/customer/plaid-check
Bank Account Status Check
plaid-check 1 param body → 200
POST
/customer/iban
Create an Iban account
add-iban 1 param body → 200
POST
/customer/card
Create Card for Customer
create-card-for-customer 1 param body → 200
POST
/customer
Create Customer
create-customer 1 param body → 200
DELETE
/customer/bankAccount/{token}
Delete Bank Account
delete-bank-account 2 params → 200
DELETE
/customer/card/{cardToken}
Delete Card
delete-card 2 params → 200
DELETE
/customer/iban/{token}
Delete Iban Account
delete-iban 2 params → 200
DELETE
/customer/interac/{token}
Delete Interac Account
delete-interac 2 params → 200
DELETE
/customer/paypal/{token}
Delete PayPal Account
delete-paypal 2 params → 200
DELETE
/customer/venmo/{token}
Delete Venmo Account
delete-venmo 2 params → 200
GET
/customer/balances/{merchantIdOrCreditSeed}
Get Balances
get-checkout-balances 2 params → 200
GET
/customer/v2
Get Customer
get-customer 1 param → 200412451
GET
/customer/history
Get Purchase History
get-history 2 params → 200
GET
/customer/history/{paymentId}
Get Purchase History By ID
get-customer-payment-by-id 2 params → 200

Schemas 191

The contract defines 191 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), TotalsResponse (19 properties). Each schema is shown below with its type and property counts.

CardSettings
object
41 properties 5 required
NuveiV1MerchantArgs
object
3 properties 2 required
PickIVenmoExcludeKeyofIVenmoVendorDataType
string
SubscriptionDisplay
object
9 properties 7 required
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
MerchantTheme
object
18 properties
ProgramWhitelistRequest
object
3 properties 3 required
ThreeDsChallengePreference
string
AptpayCanadaCoinflowSettings
object
1 property 1 required
MerchantScope
string
Verification
object
8 properties 3 required
PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsBlockConfigOverride
object
Per-customer overrides of merchant blockConfig. Only honored when they raise the effective limit.
1 property
PortalBrand
string
Customers_GetHistory_Response_200
object
1 property 1 required
BlockingRuleMethod
string
ProgramWhitelistStatus
string
AptpayCanadaMerchantSettings
object
1 property 1 required
VerificationRequiredResponse
object
5 properties 1 required
ApaProcessor
string
Record_string.InterchangeRate_
object
Construct a type with a set of properties K of type T
PickICustomerWithAccountsExcludeKeyofICustomerWithAccountsFraudControlFieldsMerchant
PlaidBalanceData
object
5 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
RainAutoTopUpCadence
string
Partial_Record_Currency.number__
object
Make all properties in T optional
156 properties
Country
string
CryptoPayInSettings
object
13 properties 8 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
CardSettingsApplePayCertificates
object
5 properties 5 required
AdditionalVerification
object
5 properties 4 required
SplitNameCustomerInfo
object
14 properties 2 required
ApplePayIntegratorRegistration
object
4 properties 4 required
BankAccountType
string
USState
string
CurrencyCents
object
2 properties 2 required
SettlementLocations
string
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
Blockchain
string
CustomPayInFeesConfig
array
Pick_AddACHBankAccountData.Exclude_keyofAddACHBankAccountData.plaidAccountId__
object
From T, pick a set of properties whose keys are in the union K
19 properties 11 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
PayoutProviderOption
string
CustomerPlaidCheckPostRequestBodyContentApplicationJsonSchemaAccountsItems
object
2 properties 1 required
LinkedBankAccountAccountType
string
CustomPayInFeeValue
CitconSettings
object
2 properties 1 required
ReserveStatus
string
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
WireProcessor
string
WebhookVersion
string
ApplePayPayoutProvider
string
IMerchantStringSettlementAddressesRecipientAddressesItems
object
3 properties 2 required
PixPayoutProvider
string
AcquirerInfo
object
4 properties 3 required
LinkedBankAccount
object
6 properties 5 required
IMerchantStringCheckbookSettings
object
5 properties 5 required
PayPalPayoutProvider
string
CustomPayInFeeValue1
object
4 properties 4 required
Partial_Record_WithdrawSpeed.WithdrawFeeConfig__
object
Make all properties in T optional
11 properties
ThreeDSArgs
object
Construct a type with a set of properties K of type T
7 properties 6 required
Pick_ICustomerWithAccounts.Exclude_keyofICustomerWithAccounts.FraudControlFields__
object
From T, pick a set of properties whose keys are in the union K
17 properties 10 required
MultiPlaidAccountStatusResponse
object
8 properties 2 required
VelocityControlSettings
object
5 properties 1 required
CustomPayInFeeConfig
object
2 properties 2 required
PaymentProcessor
string
IMerchantStringBlockConfig
object
9 properties
PayPalSettings
object
10 properties 5 required
MerchantBankSettlementOptions
object
3 properties 2 required
IMerchantStringWithdrawFees
object
4 properties 4 required
MerchantBrandSettings
object
3 properties
TokenizationProviderOption
string
CustomerInfo
CardData
object
13 properties 9 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
FeePayerMode
string
PickIPayPalExcludeKeyofIPayPalVendorDataType
string
IbanData
object
10 properties 4 required
DirectVendorSettlement
string
IMerchantStringRiskControls
object
1 property
VenmoProcessor
string
IbanPayoutProvider
string
WebhookEventType
string
MerchantSsoSettings
object
1 property 1 required
CustomerBalances
object
2 properties 2 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
Customers_GetCustomerPaymentById_Response_200
object
1 property 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
SubscriptionStatus
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
VenmoSettings
object
10 properties 5 required
GreenlightMerchantArgs
object
2 properties 2 required
PaymentHistory
object
7 properties 5 required
GetCustomerResponse
object
2 properties 1 required
VelocityLimitMode
string
IbanProcessor
string
InteracProcessor
string
MerchantStyle
string
SsoProvider
string
IMerchantUser
object
8 properties 2 required
VerisoulRiskThresholds
object
12 properties
VenmoPayoutProvider
string
RtpPayoutProvider
string
WirePayoutProvider
string
CashAppProcessor
string
PayPalProcessor
string
AftType
string
RainCardApplicationStatus
string
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
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
RainContractInfoOnramp
object
3 properties
CustomWithdrawFeesConfig
object
Make all properties in T optional
14 properties 3 required
MerchantRfiRef
object
4 properties 3 required
HighnoteMerchantSettings
object
4 properties 1 required
ICardAccountWithExpiry
object
11 properties 6 required
DisbursementStatus
string
IMerchantStringWalletsStellar
object
1 property 1 required
StableCoin
string
PayPalVendorSettings
object
7 properties 1 required
RfiStatus
string
CustomWithdrawFeeValue1
object
7 properties 6 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
RainAccountDetails
object
6 properties 4 required
CustomPayInFeeValue0
object
4 properties 4 required
RainAutoTopUpSettings
object
6 properties 3 required
InterchangeFees
object
2 properties 1 required
IMerchantStringFirstPartyPayoutOverrides
object
12 properties
CitconSettingsFundPurpose
string
AptPayCanadaSettings
WithdrawFeeConfig
object
5 properties 3 required
BlockingRuleListMode
string
NameCustomerInfo
object
13 properties
AchProcessor
string
IMerchantStringWallets
object
3 properties 3 required
VerificationVendor
string
CardDataAdditionalVendorData
object
Optional non-PCI passthrough fields merged into the stored card vendorData. Base type is empty; tokenization providers extend it with their own fields.
PlaidAccountStatus
string
Currency
string
IMerchantStringApiKeysItems
object
5 properties 3 required
TotalsResponse
object
19 properties 6 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
Cents
object
1 property 1 required
CardOnFileSettings
object
7 properties 5 required
InteracSettings
object
8 properties 2 required
TierSettings
object
3 properties 2 required
VerisoulSettings
object
2 properties 2 required
PickIInteracExcludeKeyofIInteracVendorDataType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coinflow-customers-api-openapi.yml Raw ↑

Other APIs Coinflow publishes across the network.

Coinflow authentication API
Coinflow cardTokenization API
Coinflow checkout 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
Coinflow utilities API
Where this information came from

This is an independent, third-party profile of Coinflow customers 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.