Coinflow refund API
The refund API from Coinflow — 4 operation(s) for refund.
The refund API from Coinflow — 4 operation(s) for refund.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/coinflow-refund-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Reference authentication Refund API
version: 1.0.0
servers:
- url: https://api-sandbox.coinflow.cash/api
description: https://api-sandbox.coinflow.cash/api
tags:
- name: refund
paths:
/refunds:
get:
operationId: get-refunds
summary: Get Refunds
tags:
- refund
parameters:
- name: since
in: query
required: false
schema:
type: string
- name: until
in: query
required: false
schema:
type: string
- name: status
in: query
required: false
schema:
type: string
- name: source
in: query
required: false
schema:
type: string
- name: method
in: query
required: false
schema:
type: string
- name: merchantId
in: query
required: false
schema:
type: string
- name: search
in: query
description: Payment ID or User ID / Customer ID
required: false
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RefundInfo'
/refunds/{refundId}/retry:
post:
operationId: retry-refund
summary: Retry a Failed Refund
tags:
- refund
parameters:
- name: refundId
in: path
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Refund_RetryRefund_Response_200'
/refunds/payment/{paymentId}/all:
get:
operationId: get-refunds-via-payment-id
summary: View All Refunds for Payment
tags:
- refund
parameters:
- name: paymentId
in: path
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/IRefund'
/refunds/payment/{paymentId}:
get:
operationId: get-refund-via-payment-id
summary: View Refund Information for Payment
tags:
- refund
parameters:
- name: paymentId
in: path
required: true
schema:
type: string
- name: Authorization
in: header
required: true
schema:
type: string
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/Refund_GetRefundViaPaymentId_Response_200'
components:
schemas:
Blockchain.SOLANA:
type: string
enum:
- solana
title: Blockchain.SOLANA
IMerchantMongooseTypesObjectIdWalletsSolana:
type: object
properties:
usdcPayer:
type: string
feePayer:
type: string
required:
- usdcPayer
- feePayer
title: IMerchantMongooseTypesObjectIdWalletsSolana
IPaymentMongooseTypesObjectIdMerchant:
oneOf:
- $ref: '#/components/schemas/mongoose.Types.ObjectId'
- $ref: '#/components/schemas/IMerchant_mongoose.Types.ObjectId_'
title: IPaymentMongooseTypesObjectIdMerchant
Blockchain.TEMPO:
type: string
enum:
- tempo
title: Blockchain.TEMPO
RainCompanyCardsSettings:
type: object
properties:
enabled:
type: boolean
rainCompanyId:
type: string
externalId:
type: string
applicationStatus:
$ref: '#/components/schemas/RainCardApplicationStatus'
applicationReason:
type: string
completionLink:
type: string
submittedAt:
type: string
format: date-time
lastSyncedAt:
type: string
format: date-time
contract:
$ref: '#/components/schemas/RainContractInfo'
autoTopUp:
$ref: '#/components/schemas/RainAutoTopUpSettings'
pendingTopUps:
type: array
items:
$ref: '#/components/schemas/RainPendingTopUp'
processedSpendTxnIds:
type: array
items:
type: string
title: RainCompanyCardsSettings
BlockedStatus:
type: object
properties:
level:
$ref: '#/components/schemas/BlockedLevel'
reason:
type: string
editor:
type: string
blockedAt:
type: string
format: date-time
recoverySignature:
type: string
required:
- level
- reason
- editor
- blockedAt
title: BlockedStatus
ApaSettings:
type: object
properties:
processor:
$ref: '#/components/schemas/ApaProcessor'
feeMode:
$ref: '#/components/schemas/FeePayerMode'
fxFeeMode:
$ref: '#/components/schemas/FeePayerMode'
fixedFee:
$ref: '#/components/schemas/Cents'
feeBps:
type: number
format: double
minFee:
$ref: '#/components/schemas/Cents'
customerEmailNotifications:
type: boolean
merchantEmailNotifications:
type: boolean
required:
- customerEmailNotifications
- merchantEmailNotifications
title: ApaSettings
Blockchain.POLYGON:
type: string
enum:
- polygon
title: Blockchain.POLYGON
AptpayCanadaCoinflowSettings:
type: object
properties:
coinflow:
type: boolean
required:
- coinflow
title: AptpayCanadaCoinflowSettings
ApaPaymentStatus:
type: string
enum:
- INITIATED
- APPROVED
- DEPOSITED
- SETTLED
- FAILED
- REFUNDED
title: ApaPaymentStatus
Record_string.InterchangeRate_:
type: object
properties: {}
description: Construct a type with a set of properties K of type T
title: Record_string.InterchangeRate_
CryptoPaymentStatus:
type: string
enum:
- INITIATED
- DEPOSITED
- SETTLED
- FAILED
- REFUNDED
title: CryptoPaymentStatus
RainAutoTopUpCadence:
type: string
enum:
- transaction
- hour
- day
- week
- month
title: RainAutoTopUpCadence
BlockedLevel:
type: string
enum:
- Unverified
- Suspended
title: BlockedLevel
IMerchantStringWithdrawFeePayment:
type: object
properties:
paysGasFees:
$ref: '#/components/schemas/Partial_Record_Blockchain.boolean__'
bundleDelegatedPayoutFees:
type: boolean
paysSwapFees:
type: boolean
paysWithdrawFees:
type: boolean
title: IMerchantStringWithdrawFeePayment
IvySettings:
type: object
properties:
gbpPayinAccountId:
type: string
eurAccountId:
type: string
required:
- gbpPayinAccountId
- eurAccountId
title: IvySettings
IPayPalPaymentInfo:
type: object
properties:
status:
$ref: '#/components/schemas/PayPalPaymentStatus'
processor:
$ref: '#/components/schemas/PayPalProcessor'
token:
type: string
authOnly:
type: boolean
transaction:
type: string
capturePending:
type: boolean
description: 'This means when we tried to capture from PayPal, they returned PENDING instead of COMPLETED.
We will use this field to determine whether to refund a completed capture or not.
If it was PENDING, and then it finally comletes at a later time, just refund it automatically.'
sandboxSimulations:
$ref: '#/components/schemas/IPayPalPaymentInfoSandboxSimulations'
required:
- status
- processor
- token
title: IPayPalPaymentInfo
CryptoTiers:
type: string
enum:
- stables
- majors
- volatile
title: CryptoTiers
CurrencyCents:
type: object
properties:
cents:
type: integer
currency:
$ref: '#/components/schemas/Currency'
required:
- cents
- currency
title: CurrencyCents
Refund_RetryRefund_Response_200:
type: object
properties:
jobId:
$ref: '#/components/schemas/RefundsRefundIdRetryPostResponsesContentApplicationJsonSchemaJobId'
required:
- jobId
title: Refund_RetryRefund_Response_200
SettlementLocations:
type: string
enum:
- circle
- brale
- paper
- brale_youpay
- bastion
title: SettlementLocations
IMerchantMongooseTypesObjectIdWallets:
type: object
properties:
stellar:
$ref: '#/components/schemas/IMerchantMongooseTypesObjectIdWalletsStellar'
evm:
$ref: '#/components/schemas/IMerchantMongooseTypesObjectIdWalletsEvm'
solana:
$ref: '#/components/schemas/IMerchantMongooseTypesObjectIdWalletsSolana'
required:
- stellar
- evm
- solana
title: IMerchantMongooseTypesObjectIdWallets
PixSettings:
type: object
properties:
processor:
$ref: '#/components/schemas/PixProcessor'
feeMode:
$ref: '#/components/schemas/FeePayerMode'
fxFeeMode:
$ref: '#/components/schemas/FeePayerMode'
fixedFee:
$ref: '#/components/schemas/Cents'
feeBps:
type: number
format: double
customerEmailNotifications:
type: boolean
merchantEmailNotifications:
type: boolean
refundFeeSettings:
$ref: '#/components/schemas/RefundFeeSettings'
required:
- customerEmailNotifications
- merchantEmailNotifications
title: PixSettings
Blockchain.ETH:
type: string
enum:
- eth
title: Blockchain.ETH
IMerchantStringProcessing:
type: object
properties:
msaSigned:
type: boolean
statementsOnFile:
type: boolean
required:
- msaSigned
- statementsOnFile
title: IMerchantStringProcessing
CitconSettings:
type: object
properties:
fundPurpose:
$ref: '#/components/schemas/CitconSettingsFundPurpose'
apiKey:
type: string
required:
- fundPurpose
title: CitconSettings
RefundDenominationType:
type: string
enum:
- usd
- token
title: RefundDenominationType
IPaymentMongooseTypesObjectIdSubscription:
oneOf:
- $ref: '#/components/schemas/mongoose.Types.ObjectId'
- $ref: '#/components/schemas/ISubscription_mongoose.Types.ObjectId_'
title: IPaymentMongooseTypesObjectIdSubscription
PixPayoutProvider:
type: string
enum:
- brla
- mock
title: PixPayoutProvider
IMerchantMongooseTypesObjectIdBlockConfig:
type: object
properties:
disableMultiCardAttemptCheck:
type: boolean
description: When true, skips the multi-card attempt check (2+ distinct cards failing in 1 hour).
maxDistinctTokensPer30Days:
type: number
format: double
description: 'Maximum number of distinct card tokens a single customer may use across
non-failed/voided card payments for this merchant in a rolling 30-day
window. Apple Pay / Google Pay payments are excluded. Unset or 0 disables
the check. Customers with `failedAttemptSetting: Exempt` bypass it.'
disableDestinationAuthKey:
type: boolean
description: When true, prevents usage of destinationAuthKey for custom settlement addresses.
enableNmiSettlement:
type: boolean
description: When true, enables the settlement pipeline for NMI transactions (converts card payments to USDC).
disableInvoiceWalletPayment:
type: boolean
description: When true, disables wallet balance payments for invoices. Merchants must use checkout.
blockingRules:
type: array
items:
$ref: '#/components/schemas/IBlockingRule'
description: 'Independent geo-blocking rules for withdrawals vs card checkout, with
explicit per-rule enforcement methods (KYC address / IP / billing address).
Read via `getBlockingRules` so callers transparently see the legacy
`bannedWithdrawalStates` for un-migrated merchants.'
bannedWithdrawalStates:
type: array
items:
$ref: '#/components/schemas/USState'
whitelistedBinLocations:
type: array
items:
$ref: '#/components/schemas/Country'
failedPaymentAttemptLimit:
type: number
format: double
title: IMerchantMongooseTypesObjectIdBlockConfig
LinkedBankAccount:
type: object
properties:
routingNumber:
type: string
accountNumber:
type: string
accountType:
$ref: '#/components/schemas/LinkedBankAccountAccountType'
institutionName:
type: string
plaidAccessToken:
type: string
plaidAccountId:
type: string
required:
- routingNumber
- accountNumber
- accountType
- plaidAccessToken
- plaidAccountId
title: LinkedBankAccount
IMerchantStringCheckbookSettings:
type: object
properties:
merchantName:
type: string
secret:
type: string
key:
type: string
walletId:
type: string
id:
type: string
required:
- merchantName
- secret
- key
- walletId
- id
title: IMerchantStringCheckbookSettings
IRefundCustomer:
oneOf:
- type: string
- $ref: '#/components/schemas/ICustomer_string_'
title: IRefundCustomer
Pick_MarketplaceInfo.fixedFee-or-feePercentage_:
type: object
properties:
feePercentage:
type: number
format: double
fixedFee:
$ref: '#/components/schemas/CurrencyCents'
description: From T, pick a set of properties whose keys are in the union K
title: Pick_MarketplaceInfo.fixedFee-or-feePercentage_
VelocityControlSettings:
type: object
properties:
limitMode:
$ref: '#/components/schemas/VelocityLimitMode'
customLimit:
type: number
format: double
haltOnThreshold:
type: boolean
lastHaltNotificationSentAt:
type: string
format: date-time
lastSettlementPausedNotificationSentAt:
type: string
format: date-time
required:
- limitMode
title: VelocityControlSettings
PaymentProcessor:
type: string
enum:
- payarc
- mock
- shift4
- merchant_warrior
- greenlight
- frame
- nmi_direct
- mvb
- fifththird
- natwest
- nuveiv1
- fallback_payarc_shift4
- fallback_shift4_payarc
- fallback_shift4_nuvei
- fallback_nuvei_payarc
- fallback_payarc_nuvei
- fallback_shift4_greenlight
- fallback_greenlight_shift4
- fallback_frame_merchant_warrior
- fallback_merchant_warrior_frame
- fallback_natwest_shift4
- fallback_natwest_nuvei
- fallback_natwest_shift4_payarc
- fallback_natwest_shift4_nuvei
- fallback_shift4_natwest_payarc
- fallback_nuvei_natwest_payarc
- fallback_natwest_nuvei_payarc
- fallback_mvb_fifththird_shift4_payarc
- fallback_fifththird_mvb_shift4_payarc
- fallback_mvb_nuvei
- fallback_nuvei_fifththird
- fallback_fifththird_nuvei
title: PaymentProcessor
IMerchantStringBlockConfig:
type: object
properties:
disableMultiCardAttemptCheck:
type: boolean
description: When true, skips the multi-card attempt check (2+ distinct cards failing in 1 hour).
maxDistinctTokensPer30Days:
type: number
format: double
description: 'Maximum number of distinct card tokens a single customer may use across
non-failed/voided card payments for this merchant in a rolling 30-day
window. Apple Pay / Google Pay payments are excluded. Unset or 0 disables
the check. Customers with `failedAttemptSetting: Exempt` bypass it.'
disableDestinationAuthKey:
type: boolean
description: When true, prevents usage of destinationAuthKey for custom settlement addresses.
enableNmiSettlement:
type: boolean
description: When true, enables the settlement pipeline for NMI transactions (converts card payments to USDC).
disableInvoiceWalletPayment:
type: boolean
description: When true, disables wallet balance payments for invoices. Merchants must use checkout.
blockingRules:
type: array
items:
$ref: '#/components/schemas/IBlockingRule'
description: 'Independent geo-blocking rules for withdrawals vs card checkout, with
explicit per-rule enforcement methods (KYC address / IP / billing address).
Read via `getBlockingRules` so callers transparently see the legacy
`bannedWithdrawalStates` for un-migrated merchants.'
bannedWithdrawalStates:
type: array
items:
$ref: '#/components/schemas/USState'
whitelistedBinLocations:
type: array
items:
$ref: '#/components/schemas/Country'
failedPaymentAttemptLimit:
type: number
format: double
title: IMerchantStringBlockConfig
PayPalSettings:
type: object
properties:
processor:
$ref: '#/components/schemas/PayPalProcessor'
feeMode:
$ref: '#/components/schemas/FeePayerMode'
fxFeeMode:
$ref: '#/components/schemas/FeePayerMode'
maxFee:
$ref: '#/components/schemas/Cents'
fixedFee:
$ref: '#/components/schemas/Cents'
feeBps:
type: number
format: double
minFee:
$ref: '#/components/schemas/Cents'
customerEmailNotifications:
type: boolean
merchantEmailNotifications:
type: boolean
refundFeeSettings:
$ref: '#/components/schemas/RefundFeeSettings'
required:
- fixedFee
- feeBps
- minFee
- customerEmailNotifications
- merchantEmailNotifications
title: PayPalSettings
MerchantBankSettlementOptions:
type: object
properties:
token:
type: string
minRemainingBalance:
$ref: '#/components/schemas/Cents'
useWire:
type: boolean
required:
- token
- minRemainingBalance
title: MerchantBankSettlementOptions
CustomerInfo:
oneOf:
- $ref: '#/components/schemas/SplitNameCustomerInfo'
- $ref: '#/components/schemas/NameCustomerInfo'
title: CustomerInfo
RefundMethod:
type: string
enum:
- Card
- Ach
- Pix
- Iban
- Wire
- Crypto
- CashApp
- APA
- PayPal
- Venmo
- Interac
title: RefundMethod
ISubscriptionStringCustomer:
oneOf:
- type: string
- $ref: '#/components/schemas/ICustomer_string_'
title: ISubscriptionStringCustomer
FeePayerMode:
type: string
enum:
- user
- merchant
- invoice
title: FeePayerMode
AVSResponseCode:
type: string
enum:
- A
- B
- C
- D
- E
- G
- I
- M
- N
- O
- P
- R
- S
- U
- W
- X
- Y
- Z
description: 'AVS (Address Verification System) Response Codes
These codes indicate the results of address verification checks'
title: AVSResponseCode
IbanPayoutProvider:
type: string
enum:
- merge
- mock
- ivy
title: IbanPayoutProvider
IPaymentStringPixInfo:
type: object
properties:
reason:
type: string
processed:
type: string
format: date-time
transaction:
type: string
tokenSubtotal:
$ref: '#/components/schemas/TokenSubtotal'
expiration:
type: string
format: date-time
processor:
$ref: '#/components/schemas/PixProcessor'
status:
$ref: '#/components/schemas/PixPaymentStatus'
required:
- expiration
- processor
- status
title: IPaymentStringPixInfo
VenmoPaymentStatus:
type: string
enum:
- INITIATED
- AUTHORIZED
- DEPOSITED
- SETTLED
- REFUNDED
- FAILED
- CHARGEBACK
- CHARGEBACK_LOST
- CHARGEBACK_WON
- VOIDED
title: VenmoPaymentStatus
IMerchant_string_:
type: object
properties:
_id:
type: string
merchantId:
type: string
verification:
$ref: '#/components/schemas/Verification'
brand:
$ref: '#/components/schemas/MerchantBrandSettings'
colors:
$ref: '#/components/schemas/MerchantTheme'
url:
type: string
withdrawFees:
$ref: '#/components/schemas/IMerchantStringWithdrawFees'
customWithdrawFees:
$ref: '#/components/schemas/CustomWithdrawFeesConfig'
customPayInFees:
$ref: '#/components/schemas/CustomPayInFeesConfig'
wallets:
$ref: '#/components/schemas/IMerchantStringWallets'
apiKey:
type: string
webhookValidationKey:
type: string
nmiWebhookValidationKey:
type: string
apiKeys:
type: array
items:
$ref: '#/components/schemas/IMerchantStringApiKeysItems'
kycType:
$ref: '#/components/schemas/KycType'
settlementToken:
$ref: '#/components/schemas/StableCoin'
settlementAddresses:
$ref: '#/components/schemas/IMerchantStringSettlementAddresses'
users:
type: array
items:
$ref: '#/components/schemas/IMerchantUser'
ubos:
type: array
items:
$ref: '#/components/schemas/UboEntry'
goLiveChecklist:
$ref: '#/components/schemas/MerchantGoLiveChecklist'
webhookSettings:
$ref: '#/components/schemas/WebhookSettings'
cardSettings:
$ref: '#/components/schemas/CardSettings'
achSettings:
$ref: '#/components/schemas/ACHSettings'
citconSettings:
$ref: '#/components/schemas/CitconSettings'
aptPayCanadaSettings:
$ref: '#/components/schemas/AptPayCanadaSettings'
wireSettings:
$ref: '#/components/schemas/IWireProviderSettings'
pixSettings:
$ref: '#/components/schemas/PixSettings'
ibanSettings:
$ref: '#/components/schemas/IbanSettings'
cryptoPayinSettings:
$ref: '#/components/schemas/CryptoPayInSettings'
passiveWithdrawSettings:
$ref: '#/components/schemas/PassiveWithdrawSettings'
cashAppSettings:
$ref: '#/components/schemas/CashAppSettings'
rainCompanyCards:
$ref: '#/components/schemas/RainCompanyCardsSettings'
paypalSettings:
$ref: '#/components/schemas/PayPalSettings'
venmoSettings:
$ref: '#/components/schemas/VenmoSettings'
apaSettings:
$ref: '#/components/schemas/ApaSettings'
verisoulSettings:
$ref: '#/components/schemas/VerisoulSettings'
blockConfig:
$ref: '#/components/schemas/IMerchantStringBlockConfig'
hideBranding:
type: boolean
onlyShowTotal:
type: boolean
skipSendWithdrawEmail:
type: boolean
sendInvoiceNotifications:
type: boolean
advancedAnalytics:
type: boolean
billingEmails:
type: array
items:
type: string
withdrawFeePayment:
$ref: '#/components/schemas/IMerchantStringWithdrawFeePayment'
pushToCardEnabled:
type: boolean
requireAniCheck:
type: boolean
bankPayoutProvider:
type: array
items:
$ref: '#/components/schemas/PayoutProviderOption'
ibanPayoutProviders:
type: array
items:
$ref: '#/components/schemas/IbanPayoutProvider'
ibanPayoutProvider:
$ref: '#/components/schemas/IbanPayoutProvider'
rtpPayoutProviders:
type: array
items:
$ref: '#/components/schemas/RtpPayoutProvider'
rtpPayoutProvider:
$ref: '#/components/schemas/RtpPayoutProvider'
pixPayoutProviders:
type: array
items:
$ref: '#/components/schemas/PixPayoutProvider'
pixPayoutProvider:
$ref: '#/components/schemas/PixPayoutProvider'
eftPayoutProviders:
type: array
items:
$ref: '#/components/schemas/EftPayoutProvider'
eftPayoutProvider:
$ref: '#/components/schemas/EftPayoutProvider'
p2cPayoutProviders:
type: array
items:
$ref: '#/components/schemas/CardPayoutProvider'
p2cPayoutProvider:
$ref: '#/components/schemas/CardPayoutProvider'
globalP2cPayoutProvider:
$ref: '#/components/schemas/CardPayoutProvider'
appleP2cPayoutProvider:
$ref: '#/components/schemas/ApplePayPayoutProvider'
venmoPayoutProviders:
type: array
items:
$ref: '#/components/schemas/VenmoPayoutProvider'
venmoPayoutProvider:
$ref: '#/components/schemas/VenmoPayoutProvider'
paypalPayoutProviders:
type: array
items:
$ref: '#/components/schemas/PayPalPayoutProvider'
paypalPayoutProvider:
$ref: '#/components/schemas/PayPalPayoutProvider'
wirePayoutProvider:
type: array
items:
$ref: '#/components/schemas/WirePayoutProvider'
interacPayoutProviders:
type: array
items:
$ref: '#/components/schemas/InteracPayoutProvider'
interacPayoutProvider:
$ref: '#/components/schemas/InteracPayoutProvider'
interacPaymentProvider:
$ref: '#/components/schemas/InteracProcessor'
interacSettings:
$ref: '#/components/schemas/InteracSettings'
withdrawSorting:
$ref: '#/components/schemas/Partial_Record_WithdrawSpeed.WithdrawSort__'
withdrawRules:
type: array
items:
type: string
firstPartyPayoutOverrides:
$ref: '#/components/schemas/IMerchantStringFirstPartyPayoutOverrides'
maxTransactionAmount:
$ref: '#/components/schemas/Cents'
minTransactionAmount:
$ref: '#/components/schemas/Cents'
refundBalanceLimit:
$ref: '#/components/schemas/Cents'
parent:
type: string
creditSeed:
type: string
withdrawSettlementLocation:
$ref: '#/components/schemas/SettlementLocations'
enforceJwt:
type: boolean
enforceCheckoutJwt:
type: boolean
externalVerificationLinks:
type: boolean
whitelistedAncestorUrls:
type: array
items:
type: string
banDuplicateAccounts:
type: boolean
fxFees:
$ref: '#/components/schemas/Partial_Record_Currency.number__'
blocked:
$ref: '#/components/schemas/BlockedStatus'
vendorSettings:
$ref: '#/components/schemas/VendorSettings'
generatedDescription:
type: string
bankSettlementOptions:
$ref: '#/components/schemas/MerchantBankSettlementOptions'
allowAttestedKyc:
type: boolean
attestedKycSsnNotRequired:
type: boolean
allowAccountSharing:
type: boolean
personaKycShareTokenTemplate:
type: string
delayedSettlementDays:
type: number
format: double
description: 'Number of business days to delay stablecoin settlement after payment capture.
Only applies to USDC settlements. 0 means no delay (immediate settlement).
Maximum value is 5 days.'
sendPresettleWebhooks:
type: boolean
velocitySettings:
$ref: '#/components/schemas/VelocityControlSettings'
interchangeFees:
$ref: '#/components/schemas/InterchangeFees'
enforceLivenessKyc:
type: boolean
canCreateBankAccounts:
type: boolean
checkbookSettings:
$ref: '#/components/schemas/IMerchantStringCheckbookSettings'
reserveSettings:
$ref: '#/components/schemas/ReserveSettings'
globalRateLimit:
type: number
format: double
banProxiesForCheckoutEndpoints:
type: boolean
riskControls:
$ref: '#/components/schemas/IMerchantStringRiskControls'
acceptedToS:
type: boolean
ssoSettings:
$ref: '#/components/schemas/MerchantSsoSettings'
chargebackFeeCents:
type: number
format: double
chargebackEmails:
type: array
items:
type: string
fraudEmails:
type: array
items:
type: string
linkedBankAccount:
$ref: '#/components/schemas/LinkedBankAccount'
customerDefaultOverrideLimit:
$ref: '#/components/schemas/Cents'
customerOverrideLimitCeiling:
$ref: '#/components/schemas/Cents'
customerDefaultExposureLimit:
$ref: '#/components/schemas/Cents'
dailyExposureLimit:
$ref: '#/components/schemas/Cents'
monthlyExposureLimit:
$ref: '#/components/schemas/Cents'
mcc:
type: string
processing:
$ref: '#/components/schemas/IMerchantStringProcessing'
required:
- _id
- merchantId
- verification
- withdrawFees
- wallets
- apiKey
- apiKeys
- kycType
- settlementToken
- users
- ubos
- goLiveChecklist
- cardSettings
- achSettings
- wireSettings
- pixSettings
- ibanSettings
- cryptoPayinSettings
- cashAppSettings
- paypalSettings
- venmoSettings
- apaSettings
- hideBranding
- onlyShowTotal
- skipSendWithdrawEmail
- sendInvoiceNotifications
- advancedAnalytics
- pushToCardEnabled
- requireAniCheck
- interacSettings
- refundBalanceLimit
- creditSeed
- withdrawSettlementLocation
- enforceJwt
- delayedSettlementDays
- interchangeFees
title: IMerchant_string_
MerchantEditor:
type: object
properties:
editor:
type: string
editorType:
$ref: '#/components/schemas/EditorType'
ipAddress:
type: string
required:
- editor
- editorType
- ipAddress
title: MerchantEditor
IVenmoPaymentInfo:
type: object
properties:
status:
$ref: '#/components/schemas/VenmoP
# --- truncated at 32 KB (185 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coinflow/refs/heads/main/openapi/coinflow-refund-api-openapi.yml