Alerts

Update Alert

Update the status of an alert to inform the issuing bank whether a refund will be issued. If an alert is left unactioned for 48 hours, it will be automatically declined. For the best outcome, mark alerts as resolved within 24 hours of receiving them (some smaller banks will escalate quarantined transactions as soon as 24 hours within propagating an alert). Although our API allows multiple status updates, only the first response is recognized and acted upon by the issuing bank. Optionally pass automatically_request_credit: true with a credit-eligible reason code to request and auto-grant a credit when eligible; when a credit is granted the response body includes credit_granted: true.

post/api/alerts/update/{id}

Request

  • Base URL: https://api.chargeblast.com
  • URL: https://api.chargeblast.com/api/alerts/update/{id}
  • Auth: none declared. Required headers: X-API-Key

Path parameters

idstring required

Headers

X-API-Keystring required

Your API key. Sent in the X-API-Key header.

Request body

result'Resolved' | 'ResolvedPartial' | 'ResolvedCancelled' | 'AccountCancelled' | 'CancellationProcessed' | 'UnmatchedGeneral' | 'UnmatchedCannotFindTransaction' | 'Duplicate' | 'MIDLost' | 'AlreadyRefunded' | 'AlreadyChargeback' | 'Ineligible' | 'TDS' | 'CannotCancel' | 'MatchedWillShip' | 'EscalateChargeback' | 'ContactedShipper' | 'WIP' | 'Error' | 'None' | 'NotMyDescriptor' | 'Unactioned' | '' required
action_at_expirationboolean

When set to true, the alert will be actioned at the point of expiration rather than immediately. If the alert is actioned with a different reason code before the expiration date, this action is disregarded. Intended for sending unidentified alert updates where a manual search process is also implemented. Note: If the action code is 'resolved', this field will be disregarded and the alert will be actioned as resolved immediately.

automatically_request_creditboolean

When true, automatically request and grant a credit if the reason code is credit-eligible (AlreadyRefunded, AlreadyChargeback, MIDLost, ResolvedCancelled, UnmatchedCannotFindTransaction) and the merchant/alert qualify (not on bill-per-resolved pricing, not RDR, alert age ≤ 7 days, no existing credit). If a credit will not be granted, no credit request is opened. When a credit is granted, the response includes credit_granted: true and credit_request_id.

Response

OK. Empty object when no credit was granted; includes credit_granted when an automatic credit was issued.

credit_grantedboolean

True when a credit was automatically requested and granted for this update. Omitted when no credit was granted.

credit_request_idstring

Id of the approved credit request when credit_granted is true (same as the alert id).

Changes

No recorded changes to this operation across all 1 revision of this API.