Current (2025-04-01)Merchants API
Alerts
Alerts related endpoints
Was this page helpful?
Alerts related endpoints
apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The unique Chargeflow object identifier of the alert.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The final outcome of the alert, reported back to Chargeflow. Outcome can be one of the following: refunded, previously_refunded, duplicate, decline, error, transaction_not_found.
Value in
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/public/2025-04-01/alerts/alert_123456789/outcome" \ -H "Content-Type: application/json" \ -d '{ "outcome": "refunded" }'apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The unique Chargeflow object identifier of the alert.
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/public/2025-04-01/alerts/alert_123456789"{ "id": "alert_123456789", "account_id": "account_987654321", "ext_account_id": "platform_acc_12345", "transaction": "txn_abcdef123456", "created_at": "2025-07-31T12:34:56Z", "network_transaction": { "id": "net_txn_78910", "created_at": "2025-07-31T12:30:00Z", "amount": 12500, "currency": "USD", "card_brand": "Visa", "bin": 411111, "last4": "1111", "auth_code": "AUTH1234", "arn": "ARN56789" }, "status_date": "2025-07-31T13:00:00Z", "status": "refund_initiated", "statement_descriptor": "My Merchant Store", "amount": 12500, "currency": "USD", "outcome": "refunded", "type": "fraud_warning", "reason": "fraud"}apiKey Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
The number of alerts to skip before the returned results. This is a record offset, not a page index: increment it by limit to fetch the next page.
The number of alerts to return per request.
Returns only alerts created at or before this time, in ISO 8601 format.
Returns only alerts created at or after this time, in ISO 8601 format.
Returns only the alerts with these Chargeflow alert identifiers.
Returns only alerts of this type. Type can be one of the following: fraud_warning, ethoca, cdrn, rdr, other.
Returns only alerts in this status. Status can be one of the following: alerted, pending, refund_initiated, prevented.
Returns only alerts with this reason. Reason can be one of the following: fraud, processing, authorization, service.
The field the returned alerts are sorted by.
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/public/2025-04-01/alerts?offset=0&limit=10"{ "alerts": [ { "id": "alert_123456789", "account_id": "account_987654321", "ext_account_id": "platform_acc_12345", "transaction": "txn_abcdef123456", "created_at": "2025-07-31T12:34:56Z", "network_transaction": { "id": "net_txn_78910", "created_at": "2025-07-31T12:30:00Z", "amount": 12500, "currency": "USD", "card_brand": "Visa", "bin": 411111, "last4": "1111", "auth_code": "AUTH1234", "arn": "ARN56789" }, "status_date": "2025-07-31T13:00:00Z", "status": "refund_initiated", "statement_descriptor": "My Merchant Store", "amount": 12500, "currency": "USD", "outcome": "refunded", "type": "fraud_warning", "reason": "fraud" } ], "pagination": { "totalCount": 100, "offset": 0, "limit": 25 }}