Sample API — v1

Bank Partner Monitoring API

Guardyen runs synthetic test payments through your banking partners' flows, and its AI spots technical issues, slowdowns and abnormal decline rates before your customers do.

Quick start

  1. 01

    Create a monitor for each partner flow with /v1/monitors.

  2. 02

    Guardyen runs test payments on your schedule.

  3. 03

    Get notified via the partner.incident.opened webhook.

Endpoints

POST/v1/monitors

Set up a partner flow monitor.

FieldTypeDescription
partner*stringPartner name, e.g. "Bank A".
flow*enumcard_auth | 3ds | payout | refund | open_banking
interval_minutesintegerHow often to test. Default 5.
alert_threshold_msintegerLatency that triggers an alert. Default 2000.

Request

curl -X POST https://api.guardyen.com/v1/monitors \
  -H "Authorization: Bearer gy_test_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"partner":"Bank A","flow":"3ds","interval_minutes":5}'

Response 200

{ "monitor_id": "mon_314", "status": "active", "next_run_at": "2026-11-10T18:50:00Z" }
GET/v1/monitors/{id}/status

Latest health of a monitor.

FieldTypeDescription
id*stringMonitor ID (path).

Request

curl -X GET https://api.guardyen.com/v1/monitors/mon_314/status \
  -H "Authorization: Bearer gy_test_sk_..." \
  -H "Content-Type: application/json"

Response 200

{
  "monitor_id": "mon_314",
  "health": "degraded",
  "uptime_24h": 0.982,
  "p95_latency_ms": 2840,
  "last_error": "3DS_ACS_TIMEOUT"
}
GET/v1/incidents

List partner incidents.

FieldTypeDescription
partnerstringFilter by partner.
statusenumopen | resolved

Request

curl -X GET https://api.guardyen.com/v1/incidents \
  -H "Authorization: Bearer gy_test_sk_..." \
  -H "Content-Type: application/json"

Response 200

{
  "incidents": [
    { "id": "inc_88", "partner": "Bank A", "flow": "3ds", "status": "open", "started_at": "2026-11-10T17:40:00Z" }
  ]
}

Error codes

CodeHTTPMeaning
BPM_UNSUPPORTED_FLOW400This partner does not support the requested flow.
BPM_CREDENTIALS_INVALID401Test credentials for the partner were rejected.
BPM_MONITOR_LIMIT429Your plan's monitor limit has been reached.

Webhook

Event partner.incident.opened is sent to your webhook endpoint.

Payload

{
  "type": "partner.incident.opened",
  "data": { "incident_id": "inc_88", "partner": "Bank A", "flow": "3ds", "symptom": "latency" }
}