API Reference

Send Notifications

patch
https://api-sandbox.koin.com.br/v1/antifraud/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
Path Params
string
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 Params
string
enum
Defaults to EVALUATION_ID

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

Allowed:
Body Params
string
enum
required
Defaults to CHARGEBACK

Notification type

Allowed:
string
enum

Notification subtype. Required for STATUS, CHARGEBACK and RFI types.

Allowed:
string

Descriptive message about notification

string
required

Notification date

details
object

Notification details. It's a set of key/value pairs

string

Reason for the notification. Applies to CANCELLED and NOT_COLLECTED sub_types. For CANCELLED sub_type, allowed values are enumerated in CancelledNotification.reason. For NOT_COLLECTED sub_type, it is a free text field.

string

Authorization code. Applies to COLLECTED sub_type.

string

Payment Identifier. Applies to COLLECTED sub_type.

boolean

Indicates if it is a full refund. Applies to REFUNDED sub_type.

strategies
array of objects

Strategies applied. Applies to RECOVERING sub_type.

strategies
Responses
200

Notifications response

Updated 11 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago