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
paymentIntentIdstring
liabilityOwnerenum
Allowed values:
errorstring
signaturestring
batchSignatureslist of objects
webhookInfoobject
velocityDatedatetime
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
cardInfoobject
bankTransferInfoobject
pixInfoobject
ibanInfoobject
wireInfoobject
cashAppInfoobject
rainInfoobject
cryptoInfoobject
exchangeInfoobject
subscriptionstring or object
settlementTypeenum
Allowed values:
blockchainenum
walletstring
redemptionCheckboolean
marketplaceInfoobject
destinationstring
destinationSettlementTokenstring
overrideAuditLogobject
customerUsdcTransferDataobject

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

customerUsdcTransferDataV2object

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.

delayedSettlementobject
referrerstring
alertStatusenum
Allowed values:
refundInfoobject
userLocationobject

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.

entityTagobject