Coinflow refund API
The refund API from Coinflow — 4 operation(s) for refund.
Coinflow refund API is one of 14 APIs that Coinflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Refund. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 4 operations across 4 paths, and defines 321 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.
4 operations
4 paths
321 schemas
3 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 8
Coinflow refund 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 4
Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
refund 4
GET
/refunds
Get Refunds
POST
/refunds/{refundId}/retry
Retry a Failed Refund
GET
/refunds/payment/{paymentId}/all
View All Refunds for Payment
GET
/refunds/payment/{paymentId}
View Refund Information for Payment
Schemas 321
The contract defines 321 schemas that model the data the API accepts and returns. The most detailed are Partial_Record_Currency.number__ (156 properties), IMerchant_mongoose.Types.ObjectId_ (115 properties), IMerchant_string_ (115 properties), IPayment_mongoose.Types.ObjectId_ (45 properties). Each schema is shown below with its type and property counts.
Blockchain.SOLANA
string
IMerchantMongooseTypesObjectIdWalletsSolana
object
2 properties
2 required
IPaymentMongooseTypesObjectIdMerchant
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
Record_string.InterchangeRate_
object
Construct a type with a set of properties K of type T
CryptoPaymentStatus
string
RainAutoTopUpCadence
string
BlockedLevel
string
IMerchantStringWithdrawFeePayment
object
4 properties
IvySettings
object
2 properties
2 required
IPayPalPaymentInfo
object
7 properties
3 required
CryptoTiers
string
CurrencyCents
object
2 properties
2 required
Refund_RetryRefund_Response_200
object
1 property
1 required
SettlementLocations
string
IMerchantMongooseTypesObjectIdWallets
object
3 properties
3 required
PixSettings
object
8 properties
2 required
Blockchain.ETH
string
IMerchantStringProcessing
object
2 properties
2 required
CitconSettings
object
2 properties
1 required
RefundDenominationType
string
IPaymentMongooseTypesObjectIdSubscription
PixPayoutProvider
string
IMerchantMongooseTypesObjectIdBlockConfig
object
9 properties
LinkedBankAccount
object
6 properties
5 required
IMerchantStringCheckbookSettings
object
5 properties
5 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
PayPalSettings
object
10 properties
5 required
MerchantBankSettlementOptions
object
3 properties
2 required
CustomerInfo
RefundMethod
string
ISubscriptionStringCustomer
FeePayerMode
string
AVSResponseCode
string
AVS (Address Verification System) Response Codes These codes indicate the results of address verification checks
IbanPayoutProvider
string
IPaymentStringPixInfo
object
7 properties
3 required
VenmoPaymentStatus
string
IMerchant_string_
object
115 properties
36 required
MerchantEditor
object
3 properties
3 required
IVenmoPaymentInfo
object
7 properties
3 required
CustomerUsdcTransferDataV2ValidAfter
FailedIbanAttempt
object
3 properties
3 required
RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaCustomer
SubscriptionStatus
string
AftPurpose
string
Partial_Record_WithdrawSpeed.WithdrawSort__
object
Make all properties in T optional
11 properties
IMerchantStringWalletsSolana
object
2 properties
2 required
GreenlightMerchantArgs
object
2 properties
2 required
ISubscriptionMongooseTypesObjectIdCustomer
Blockchain.MONAD
string
IbanProcessor
string
EnhancedTxInfoIpLocation
object
10 properties
7 required
RefundTotals
object
6 properties
5 required
IMerchantUser
object
8 properties
2 required
mongoose.Types.ObjectId
string
WirePayoutProvider
string
IMerchantMongooseTypesObjectIdWalletsEvm
object
2 properties
2 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
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
IMerchantMongooseTypesObjectIdRiskControls
object
1 property
PayPalVendorSettings
object
7 properties
1 required
RfiStatus
string
CustomerVerificationSetting
string
WirePaymentStatus
string
InterchangeFees
object
2 properties
1 required
WithdrawFeeConfig
object
5 properties
3 required
AptPayCanadaSettings
IVenmoPaymentInfoSandboxSimulations
object
3 properties
IPaymentMongooseTypesObjectIdCardInfo
object
18 properties
3 required
KytAlertStatus
string
IPaymentStringMerchant
Currency
string
Cents
object
1 property
1 required
ICustomer_mongoose.Types.ObjectId_
object
20 properties
9 required
CitconSettingsFundPurpose
string
Refund_GetRefundViaPaymentId_Response_200
object
23 properties
15 required
UboEntry
object
9 properties
3 required
RefundInfo
object
13 properties
10 required
CustomerOverrideAuditLog
object
5 properties
1 required
Verification
object
8 properties
3 required
ICustomerMongooseTypesObjectIdBlockConfigOverride
object
Per-customer overrides of merchant blockConfig. Only honored when they raise the effective limit.
1 property
IMerchantMongooseTypesObjectIdSettlementAddresses
object
13 properties
ApaProcessor
string
Record_string.any_
object
Construct a type with a set of properties K of type T
IApaPaymentInfo
object
10 properties
5 required
OrchestrationTraversalStepNodeType
string
RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaPayment
IPaymentStringCardInfo
object
18 properties
3 required
CryptoPayInSettings
object
13 properties
8 required
ReserveSettings
object
4 properties
3 required
RefundFeeSettings
object
4 properties
CardSettingsApplePayCertificates
object
5 properties
5 required
USState
string
IMerchantMongooseTypesObjectIdWithdrawFees
object
4 properties
4 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
CrbEnvironment
string
Blockchain.STELLAR
string
ICustomerStringMerchant
Partial_WithdrawLimit_
object
Make all properties in T optional
3 properties
CardType
string
PayoutProviderOption
string
PixProcessor
string
MobileWallet
string
OrchestrationInfo
object
8 properties
IPaymentStringSubscription
PayPalPayoutProvider
string
ThreeDSArgs
object
Construct a type with a set of properties K of type T
7 properties
6 required
BinInfoCountry
IRefundMerchant
IWirePaymentInfo
object
11 properties
5 required
ICustomer_string_
object
20 properties
9 required
FailedAttemptSetting
string
VenmoProcessor
string
EftPayoutProvider
string
IMerchantStringSettlementAddresses
object
13 properties
CardPayoutProvider
string
IPaymentStringDelayedSettlement
object
5 properties
4 required
Funding
string
Segment
string
IMerchantMongooseTypesObjectIdCheckbookSettings
object
5 properties
5 required
IMerchantMongooseTypesObjectIdProcessing
object
2 properties
2 required
VenmoSettings
object
10 properties
5 required
IMerchantMongooseTypesObjectIdApiKeysItems
object
5 properties
3 required
Blockchain.BASE
string
ISubscription_string_
object
14 properties
9 required
ISubscription_mongoose.Types.ObjectId_
object
14 properties
9 required
VerisoulRiskThresholds
object
12 properties
PayPalProcessor
string
SettlementType
string
LiabilityOwner
string
CustomWithdrawFeeValue1
object
7 properties
6 required
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
TokenSubtotalAmount
Number of tokens
IMerchantStringApiKeysItems
object
5 properties
3 required
ISubscriptionPlan_string_
object
13 properties
7 required
ExchangeInfo
object
3 properties
2 required
AnyObject
object
1 property
VerificationStatus
string
IPaymentStringVendorTransfer
object
2 properties
1 required
AvailabilityStatus
string
ThreeDsChallengePreference
string
PortalBrand
string
BlockingRuleMethod
string
OrchestrationFailedAttempt
object
3 properties
1 required
AptpayCanadaMerchantSettings
object
1 property
1 required
SubscriptionVersion
string
IMerchantMongooseTypesObjectIdSettlementAddressesRecipientAddressesItems
object
3 properties
2 required
EnhancedTxInfo
object
19 properties
ACHSettings
object
16 properties
4 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
Country
string
IPaymentMongooseTypesObjectIdCryptoInfo
object
20 properties
1 required
AftSettingsMerchantA2AMastercardAftRecipient
object
8 properties
8 required
IWireProviderSettings
object
11 properties
2 required
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
IPaymentMongooseTypesObjectIdCustomer
CoinflowEntity
string
The Coinflow legal entity that owns a transaction. Used for compliance/finance's per-payment entity reporting (14259).
ChargebackProtectionDecision
string
IMerchantMongooseTypesObjectIdWithdrawFeePayment
object
4 properties
RefundSource
string
ISubscriptionMongooseTypesObjectIdMerchant
IMerchantStringSettlementAddressesRecipientAddressesItems
object
3 properties
2 required
BinInfo
object
5 properties
5 required
AcquirerInfo
object
4 properties
3 required
ISubscriptionMongooseTypesObjectIdPlan
CardPaymentStatus
string
IMerchantStringRiskControls
object
1 property
WebhookEventType
string
MerchantSsoSettings
object
1 property
1 required
BraidMerchantSettings
object
7 properties
5 required
ISubscriptionStringPlan
IMerchantStringWalletsEvm
object
2 properties
2 required
WithdrawSort
string
IMerchant_mongoose.Types.ObjectId_
object
115 properties
36 required
VelocityLimitMode
string
CustomerUsdcTransferDataValidAfter
ICashAppPaymentInfo
object
7 properties
5 required
MerchantStyle
string
RtpPayoutProvider
string
VenmoPayoutProvider
string
ISubscriptionPlan_mongoose.Types.ObjectId_
object
13 properties
7 required
IPaymentStringIbanInfo
object
12 properties
4 required
CashAppProcessor
string
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
AftType
string
VendorSettings
object
8 properties
MarketplaceInfo
object
5 properties
ISubscriptionPlanStringMerchant
IPaymentStringBankTransferInfo
object
8 properties
3 required
IPaymentMongooseTypesObjectIdRefundInfo
object
3 properties
3 required
StableCoin
string
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
OverrideAuditLog
object
5 properties
1 required
CustomPayInFeeValue0
object
4 properties
4 required
RainAutoTopUpSettings
object
6 properties
3 required
NameCustomerInfo
object
13 properties
IMerchantStringWallets
object
3 properties
3 required
VerificationVendor
string
PixPaymentStatus
string
OverrideMethod
string
OperationalBlockchain
Verification3DS
string
InteracSettings
object
8 properties
2 required
IPaymentMongooseTypesObjectIdBankTransferInfo
object
8 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
ICustomerMongooseTypesObjectIdMerchant
CashAppPaymentStatus
string
MerchantScope
string
ProgramWhitelistStatus
string
RefundStatus
string
PayPalPaymentStatus
string
FraudReport
object
3 properties
2 required
IPaymentMongooseTypesObjectIdIbanInfo
object
12 properties
4 required
OrchestrationTraversalStep
object
4 properties
2 required
Partial_Record_Currency.number__
object
Make all properties in T optional
156 properties
CrbMerchantArgs
object
2 properties
SplitNameCustomerInfo
object
14 properties
2 required
ApplePayIntegratorRegistration
object
4 properties
4 required
IPaymentMongooseTypesObjectIdPixInfo
object
7 properties
3 required
RainPendingTopUp
object
3 properties
3 required
RainContractInfo
object
10 properties
5 required
MerchantGoLiveChecklist
object
7 properties
IPayment_mongoose.Types.ObjectId_
object
45 properties
7 required
Blockchain
string
RefundReason
string
VendorSettingsKoard
object
4 properties
1 required
CustomPayInFeeValue
AchPaymentStatus
string
WireProcessor
string
StoredCardTransactionType
string
WebhookVersion
string
ApplePayPayoutProvider
string
RefundsPaymentPaymentIdGetResponsesContentApplicationJsonSchemaMerchant
IPaymentStringCryptoInfo
object
20 properties
1 required
CVVResponseCode
string
CVV (Card Verification Value) Response Codes These codes indicate the results of CVV verification checks
IPaymentMongooseTypesObjectIdUserLocation
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
CustomPayInFeeValue1
object
4 properties
4 required
Partial_Record_WithdrawSpeed.WithdrawFeeConfig__
object
Make all properties in T optional
11 properties
IMerchantMongooseTypesObjectIdFirstPartyPayoutOverrides
object
12 properties
CustomPayInFeeConfig
object
2 properties
2 required
InteracPaymentStatus
string
IMerchantStringWithdrawFees
object
4 properties
4 required
MerchantBrandSettings
object
3 properties
TokenizationProviderOption
string
IPaymentMongooseTypesObjectIdDelayedSettlement
object
5 properties
4 required
DirectVendorSettlement
string
CashAppSettings
object
8 properties
2 required
WebhookSettings
object
5 properties
3 required
EditorType
string
BlockingRuleScope
string
WalletDebitStatus
string
OverrideMethod.CustomerOverride
string
KycType
string
InteracPayoutProvider
string
IbanPaymentStatus
string
InteracProcessor
string
CustomerUsdcTransferDataV2ValidBefore
IPaymentStringRefundInfo
object
3 properties
3 required
SsoProvider
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
IRefund
object
23 properties
13 required
IInteracPaymentInfo
object
10 properties
5 required
IAvailability
object
4 properties
4 required
RainCardApplicationStatus
string
TokenSubtotal
object
3 properties
2 required
IMerchantMongooseTypesObjectIdWalletsStellar
object
1 property
1 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
IPaymentMongooseTypesObjectIdVendorTransfer
object
2 properties
1 required
RainAccountDetails
object
6 properties
4 required
IPaymentStringCustomer
CustomerUsdcTransferDataValidBefore
BlockingRuleListMode
string
ISubscriptionPlanMongooseTypesObjectIdMerchant
RefundsRefundIdRetryPostResponsesContentApplicationJsonSchemaJobId
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
AchProcessor
string
TotalsResponse
object
19 properties
6 required
CardOnFileSettings
object
7 properties
5 required
CryptoRefundInfo
object
7 properties
2 required
TierSettings
object
3 properties
2 required
VerisoulSettings
object
2 properties
2 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
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 subMerchant API
Coinflow subscription API
Coinflow utilities API
#Refund
Where this information came from
This is an independent, third-party profile of Coinflow refund 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.