COcoinflow
merchant

Get Payment By ID

Changed on

Returns the payment. When the caller's scope grants access to enhanced transaction information (CHARGEBACK / CHARGEBACK_ANALYST_READ, or admin), that info is consolidated onto the response under enhancedTxInfo so it can be retrieved in a single call instead of also hitting GET /merchant/payments/enhanced/{paymentId}.

get/merchant/payments/{paymentId}

Request

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

Path parameters

paymentIdstring required
  • ID of the payment to retrieve

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