Sign in

v3

OpenAPI 3.1.02026-08-06186981679.4 KB
merchant

Get All Payments

get/merchant/payments

Query parameters

sincestring
  • UTC epoch milliseconds of the earliest date to include in the results
untilstring
  • UTC epoch milliseconds of the latest date to include in the results
pagenumber double
  • Page number to return starting from 1. Must be used with limit param.
limitnumber double
  • amount of records per page (def. 100). Must be used with page param.
statusstring
searchstring
sortBy'createdAt' | 'amount'
sortDirectionnumber double
methodstring
protectionstring
merchantIdstring
amountstring
authCodestring

Headers

Authorizationstring required

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

Response

Ok

_idstring required
paymentIdstring required
paymentIntentIdstring
chargebackProtectionDecision'approved' | 'rejected' | 'Not Reviewed' | 'Not Enabled' | 'Overridden' | 'Pending Review' required
liabilityOwner'coinflow-entity' | 'coinflow' | 'merchant'
overrideChargebackProtectionDecisionboolean
chargebackProtectionAccountType'guest' | 'private' | 'business'
doNotReviewChargebackProtectionboolean
errorstring
signaturestring
createdAtstring date-time required
velocityDatestring date-time

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

settlementType'Credits' | 'USDC'
walletstring
redemptionCheckboolean
destinationstring
destinationSettlementTokenstring
referrerstring
alertStatus'open' | 'blocked'
feesInvoicedPeriodstring
invoiceIdstring

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.

vendorInfoRecordStringString

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