API Reference

Send notifications to Koin

API to send notifications to Koin about an existing transaction.

patch https://api-sandbox.koin.com.br/payment/v1/notifications/{id}?field=REFERENCE_ID

The query parameter in the URL {id} has to be the reference id sent by client in each transaction.

Types of notifications: Finalized and Cancelled

string
required

Notification type

In this case: STATUS

string
required

Notification subtype

In this case: CANCELLED

string

Reason why the case has been cancelled

string

Descriptive message about notification

string
required

Notification date

object

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

string
required

Notification type

In this case: STATUS

string
required

Notification subtype

In this case: FINALIZED

string

Descriptive message about notification

string
required

Notification date

object

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

Examples

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

{
  "type": "STATUS",
  "sub_type": "CANCELLED",
  "reason": "REQUESTED_BY_CUSTOMER",
  "message": "Notification about...",
  "notification_date": "2021-02-23T14:10:44.307062Z"
}