Current (2025-04-01)Merchants API
Alerts
Alerts related endpoints
Authorization
apiKey x-api-key<token>
Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
Path Parameters
alertId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
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" }'Empty
Authorization
apiKey x-api-key<token>
Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
Path Parameters
alertId*string
The unique Chargeflow object identifier of the alert.
Response Body
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": "pending", "type": "fraud_warning", "reason": "fraud"}Authorization
apiKey x-api-key<token>
Your Chargeflow API key, sent on every request. Generate one in the Chargeflow App, or see API keys.
In: header
Query Parameters
offset?string
limit?string
created_at_max?string
created_at_min?string
ids?string
type?string
status?string
reason?string
sort?string
Response Body
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": "pending", "type": "fraud_warning", "reason": "fraud" } ], "pagination": { "totalCount": 100, "offset": 0, "limit": 25, "totalPages": 54 }}Was this page helpful?