merchant

Get All Payments

Changed on
get/merchant/payments

Request

  • Base URL
    https://api-sandbox.coinflow.cash/api
  • URL
    https://api-sandbox.coinflow.cash/api/merchant/payments
  • Auth
    API key in header Authorization

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
processorstring
protectionstring
merchantIdstring
amountstring
authCodestring
cardTypestring
  • card network (VISA / MSTR / AMEX / DISC), comma separated
last4string
  • last four digits of the card, comma separated
paymentIdstring
  • comma separated payment ids
customerstring
  • customerId, email or customer ObjectId, comma separated

Response

Ok

_idstring required
paymentIdstring required
paymentIntentIdstring
idempotencyKeystring

The checkout link's idempotency key: the one the merchant passed when creating the link, or the one generated for them.

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
destinationSettlementTokenstring
referrerstring
alertStatus'open' | 'blocked'
fundsReturnedAtstring date-time

Set when a KYT-blocked payment's funds are sent back to the originating wallet; alertStatus is unset at the same time

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

Changes