Current (2025-04-01)Merchants API
Alerts
Authorization
apiKey x-api-key<token>
Your Chargeflow API key. Generate it in the Developer Hub under Settings.
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/string/outcome" \ -H "Content-Type: application/json" \ -d '{ "outcome": "refunded" }'Empty
Authorization
apiKey x-api-key<token>
Your Chargeflow API key. Generate it in the Developer Hub under Settings.
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/string"{ "id": "string", "account_id": "string", "ext_account_id": "string", "transaction": "string", "created_at": "2019-08-24T14:15:22Z", "network_transaction": { "id": "string", "created_at": "2019-08-24T14:15:22Z", "amount": 0, "currency": "str", "card_brand": "string", "bin": "string", "last4": "string", "auth_code": "string", "arn": "string" }, "status_date": "2019-08-24T14:15:22Z", "status": "string", "statement_descriptor": "string", "amount": 0, "currency": "str", "outcome": "string", "type": "string", "reason": "string"}Authorization
apiKey x-api-key<token>
Your Chargeflow API key. Generate it in the Developer Hub under Settings.
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"{ "alerts": [ { "id": "string", "account_id": "string", "ext_account_id": "string", "transaction": "string", "created_at": "2019-08-24T14:15:22Z", "network_transaction": { "id": "string", "created_at": "2019-08-24T14:15:22Z", "amount": 0, "currency": "str", "card_brand": "string", "bin": "string", "last4": "string", "auth_code": "string", "arn": "string" }, "status_date": "2019-08-24T14:15:22Z", "status": "string", "statement_descriptor": "string", "amount": 0, "currency": "str", "outcome": "string", "type": "string", "reason": "string" } ], "pagination": { "totalCount": 0, "offset": 0, "limit": 25, "totalPages": 0 }}Was this page helpful?