API ReferenceMerchant

Get Returned ACH Payments

Authentication

Authorizationstring
The API key of the merchant - see https://docs.coinflow.cash/api-reference/api-reference/authentication/get-session-key
OR
Authorizationstring
API Key authentication via header

Query parameters

sincestringOptional
- UTC ISO String of the earliest date to include in the results
untilstringOptional
- UTC ISO String of the latest date to include in the results
pageSizedoubleOptional
- Number of results to return per page (MAX 1000)
pagedoubleOptional
- Page number to return
searchstringOptional
sortByenumOptional
Allowed values:
sortDirectiondoubleOptional
protectionstringOptional
merchantIdstringOptional

Response

Ok
_idstring
paymentIdstring
totalsobject
customerstring or object
merchantstring or object
chargebackProtectionDecisionenum
createdAtdatetime
paymentIntentIdstringOptional
liabilityOwnerenumOptional
overrideChargebackProtectionDecisionbooleanOptional
chargebackProtectionAccountTypeenumOptional
doNotReviewChargebackProtectionbooleanOptional
cartlist of objectsOptional
Cart item details required for Coinflow Chargeback Protection. Required if the merchant uses chargeback protection.
sessionInfoobjectOptional
errorstringOptional
signaturestringOptional
webhookInfoobjectOptional
velocityDatedatetimeOptional
Date when velocity check was done and used to bucket payments into velocity days Should match when a velocity hold was created if one was
cardInfoobjectOptional
bankTransferInfoobjectOptional
pixInfoobjectOptional
ibanInfoobjectOptional
wireInfoobjectOptional
cashAppInfoobjectOptional
paypalInfoobjectOptional
venmoInfoobjectOptional
apaInfoobjectOptional
interacInfoobjectOptional
cryptoInfoobjectOptional
exchangeInfoobjectOptional
subscriptionstring or objectOptional
settlementTypeenumOptional
blockchainenumOptional
walletstringOptional
redemptionCheckbooleanOptional
marketplaceInfoobjectOptional
destinationstring or objectOptional
destinationSettlementTokenstringOptional
overrideAuditLogobjectOptional
customerUsdcTransferDataobjectOptional

Customer signed USDC transferWithAuthorization data for dual-source payments Used for combined USDC + Credit Card payments on EVM chains

customerUsdcTransferDataV2objectOptional

V2 of CustomerUsdcTransferData — replaces the (v, r, s) triple with a single signature bytes string, matching USDC FiatTokenV2_2’s bytes-overload transferWithAuthorization. All other fields unchanged from V1.

delayedSettlementobjectOptional
referrerstringOptional
alertStatusenumOptional
refundInfoobjectOptional
userLocationobjectOptional

Browser-captured geolocation at the time of the request, when the caller supplied one. Stored independently of payment method so the merchant dashboard can render a map for any purchase type. resolved* fields are populated when the GEOLOCATION enforcement step happened to reverse- geocode the coordinates — they’re a free piggyback on the lock cache, not a guarantee.

entityTagobjectOptional
vendorTransferobjectOptional
feesInvoicedPeriodstringOptional
invoiceIdstringOptional

Set at settlement when the payment carries FeePayerMode.Invoice fees (totals.invoiced*Fees): the Accruing invoice the fees were attached to. Mirrors the refund/chargeback invoicing pattern — presence of invoiceId marks the fees as billed.

outstandingobjectOptional
vendorInfoobjectOptional
Construct a type with a set of properties K of type T