v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB
Support Services

Send Notifications

API to send notifications about an evaluated transaction. The types of notifications:

  • RFI: Notify a request for information (internal, from a bank, or from any entity)
  • Chargeback: Notify a chargeback (internal, from a bank, or from any entity)
  • Status
    • Collected: Transaction payment was settled
    • Not Collected: Transaction payments was failed
    • Cancelled: Transaction was cancelled
    • Finalized: Transaction finalized OK
    • Refunded: Transaction payment was refunded
    • Authorized: Transaction payment was authorized
    • Recovering: In case a strategy has been applied, informs the result. See Strategies
  • Info: Other type of information
patch/v1/antifraud/notifications/{id}

Path parameters

idstring required

Could be either Evaluation ID returned by api on evaluation :evaluation_id or reference id sent by client on evaluation :store.reference_id

Query parameters

field'EVALUATION_ID' | 'REFERENCE_ID'

Indicates which field should be used to look up the case (evalaution_id or reference_id). By default its value is EVALUATION_ID.

Request body

OR
OR
OR

Example request

{
  "message": "Notification about...",
  "notification_date": "2021-02-23T14:10:44.307062Z"
}

Response

Notifications response