Quickstart
Create an API key and read your first alert in under 5 minutes.
Create an API key
In your Disputely dashboard, go to Settings → API and click Create key.
- Give it a label (e.g.
production-backend). - Leave the default read permissions checked. Only enable Resolve alerts (write) if this key will refund customers.
Your key starts with dspm_live_ and is shown once. Copy it into your
secrets manager right away — we only store a hash, so it can't be recovered
later (you'd just create a new one).
Make your first request
List your most recent alerts:
curl "https://api.disputely.com/v1/alerts?limit=3" \
-H "Authorization: Bearer dspm_live_YOUR_KEY"You'll get back a list like this (trimmed — see Alerts for the full object):
{
"data": [
{
"id": "9XOJYR6WNLMU2XEQMSF244GFI",
"accountId": "acct_2ZK8Q1M4",
"type": "ETHOCA",
"status": "NEEDS_REVIEW",
"respondBy": "2026-10-02T18:30:00Z",
"disputeAmount": 29.97,
"disputeCurrency": "USD",
"paymentDescriptor": "ACME*STORE",
"cardInfo": { "bin": "411111", "lastFour": "4242", "accountNumber": null },
"timestamp": "2026-09-30T18:30:00Z"
}
],
"next_cursor": null,
"has_more": false
}Resolve an alert
When an alert has status: "NEEDS_REVIEW", refund the customer in your payment
system first, then tell Disputely:
curl -X POST "https://api.disputely.com/v1/alerts/9XOJYR6WNLMU2XEQMSF244GFI/resolve" \
-H "Authorization: Bearer dspm_live_YOUR_KEY" \
-H "Idempotency-Key: resolve-9XOJYR6WNLMU2XEQMSF244GFI" \
-H "Content-Type: application/json" \
-d '{ "refundedAmount": 29.97, "refundedCurrency": "USD" }'The response is the updated alert with status: "RESOLVED". The dispute is
closed with the card network and no chargeback is filed.
Resolving requires the alerts:write permission and tells the card network you
refunded the cardholder. Only call it after the refund actually went through.