Skip to main content
Circle API notifications are subscriber endpoints that enable you to receive notifications every time the status of a resource changes.

​
Common attributes

All notification messages have the following attributes:
NameTypeDescriptionSample
clientIdstring (UUIDv4)Client identifierc60d2d5b-203c-45bb-9f6e-93641d40a599
notificationTypestringThe type of notificationpayouts
versionintThe version of the data model1

​
Implementations

This section lists all notification models.

​
Payout

​
Completed

Completed payouts are settled payouts. Therefore, the funds should be available in the destination wallet. The following structure represents the notifications for completed payouts.
Completed Payout Notification Payload
{
   "clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
   "notificationType": "payouts",
   "payout": {...}
}
The payout payload is a payout object.

​
Failed

Failed payouts notifications are structured as follows:
Failed Payout Notification Payload
{
   "clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
   "notificationType": "payouts",
   "payout": {...}
}
The payout payload is a payout object.

​
Transfer

​
Created

A notification with the structure below is sent on transfer creation.
Created Transfer Notification Payload
{
   "clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
   "notificationType": "transfers",
   "transfer": {...}
}
The transfer payload is a transfer object.

​
Failed

Failed transfers notifications are structured as follows:
Failed Transfer Notification Payload
{
   "clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
   "notificationType": "transfers",
   "transfer": {...}
}
The transfer payload is a transfer object.

​
Completed

Completed transfers notifications are structured as follows:
Completed Transfer Notification Payload
{
   "clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
   "notificationType": "transfers",
   "transfer": {...}
}
The transfer payload is a transfer object.
⌘I