v3

OpenAPI 3.1.02026-08-06186981679.4 KB

merchant

Get Payment Webhook Activity

get/merchant/webhooks

Query parameters

pagenumber double

limitnumber double

responseCodestring

searchstring

Search by numeric responseCode

eventTypestring

merchantIdstring

startDatestring

Filter by sentAt >= startDate (ISO 8601)

endDatestring

Filter by sentAt <= endDate (ISO 8601)

transactionIdstring

Search by transaction Id

status'success' | 'failure'

Filter by delivery status ('success' for responseCode < 400, 'failure' for responseCode >= 400)

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

merchantIdstring required

eventType'Card Payment Authorized' | 'Card Payment Declined' | 'Card Payment Voided' | 'Credits Minted' | 'ACH Initiated' | 'ACH Success' | 'ACH Returned' | 'ACH Failed' | 'ACH Chargeback' | 'ACH Batched' | 'PIX Failed' | 'PIX Expiration' | 'Payment Authorized' | 'Payment Expiration' | 'Settled' | 'Wire Initiated' | 'USDC Payment Received' | 'Subscription Created' | 'Subscription Canceled' | 'Subscription Expired' | 'Subscription Failure' | 'Subscription Concluded' | 'Card Payment Chargeback Opened' | 'Card Payment Chargeback Won' | 'Card Payment Chargeback Lost' | 'Card Payment Suspected Fraud' | 'Payment Pending Review' | 'KYC Created' | 'KYC Success' | 'KYC Failure' | 'Sub-merchant KYB Created' | 'Sub-merchant KYB Success' | 'Sub-merchant KYB Failure' | 'Withdraw Pending' | 'Withdraw Success' | 'Withdraw Failure' | 'Seller Blocked' | 'Refund' | 'Refund Complete' | 'Refund Failure' | 'Refund Returned' | 'Wire Failure' | 'Iban Failure' | 'Interac Failure' | 'CashApp Failure' | 'PayPal Failure' | 'Venmo Failure' | 'Reserve Released' | 'Crypto Overpayment' | 'Crypto Underpayment' | 'Iban RFI Created' | 'Iban RFI Submitted' | 'Crypto Deposit Funds Received' | 'Customer Override Limit Threshold' | 'Crypto Payin Funds Received' | 'PayPal Payment Authorized' | 'PayPal Payment Voided' | 'PayPal Payment Chargeback Opened' | 'PayPal Payment Chargeback Won' | 'PayPal Payment Chargeback Lost' | 'Venmo Payment Authorized' | 'Venmo Payment Voided' | 'Venmo Payment Chargeback Opened' | 'Venmo Payment Chargeback Won' | 'Venmo Payment Chargeback Lost' | 'Disbursed Funds' | 'Unknown Wire Payment Received' required

category'Purchase' | 'Subscription' | 'KYC' | 'Withdraw' | 'Marketplace' required

providerIdstring

version'Legacy' | 'Version 1' | 'Version 2' | 'Version 3' required

sentAtstring date-time required

urlstring required

responseCodenumber double required

responseDataWebhookResponse