Circle API notifications are subscriber endpoints that enable you to receive notifications every time the status of a resource changes.
All notification messages have the following attributes:
Name | Type | Description | Sample |
---|---|---|---|
clientId | string (UUIDv4) | Client identifier | c60d2d5b-203c-45bb-9f6e-93641d40a599 |
notificationType | string | The type of notification | payouts |
version | int | The version of the data model | 1 |
This section lists all notification models.
Completed payouts are settled payouts. Therefore, the funds should be available in the destination wallet. The following structure represents the notifications for completed payouts.
{
"clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
"notificationType": "payouts",
"payout": {...}
}
The payout
payload is a
payout object.
Failed payouts notifications are structured as follows:
{
"clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
"notificationType": "payouts",
"payout": {...}
}
The payout
payload is a
payout object.
A notification with the structure below is sent on transfer creation.
{
"clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
"notificationType": "transfers",
"transfer": {...}
}
The transfer
payload is a
transfer object.
Failed transfers notifications are structured as follows:
{
"clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
"notificationType": "transfers",
"transfer": {...}
}
The transfer
payload is a
transfer object.
Completed transfers notifications are structured as follows:
{
"clientId": "c60d2d5b-203c-45bb-9f6e-93641d40a599",
"notificationType": "transfers",
"transfer": {...}
}
The transfer
payload is a
transfer object.