Skip to main content
WEBHOOK
tradeRefunded
{
  "clientId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "notification": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "contractTradeId": "24",
    "rate": 0.915,
    "createDate": "2023-01-01T12:04:05Z",
    "updateDate": "2023-01-01T12:04:05Z",
    "quoteId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "collateral": "<string>",
    "settlementTransactionHash": "0xf97c6a87511583d5c7e8e72f8e1fe38bfd24350edda78fddbe67125f3cf0a122",
    "maturity": "2023-01-01T12:04:05Z",
    "completeDate": "2023-01-01T12:04:05Z",
    "signerAddress": "0xf0e7ccf7817b30fa0dd6bdeaea3ad54c140647b2",
    "contractTransactions": {
      "recordTrade": {
        "status": "success",
        "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
        "errorDetails": "<string>"
      },
      "takerDeliver": {
        "status": "success",
        "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
        "errorDetails": "<string>"
      },
      "makerDeliver": {
        "status": "success",
        "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
        "errorDetails": "<string>"
      }
    }
  },
  "tenancyEnvironment": "TEST",
  "messageTraceId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "userId": null,
  "userGroupTypes": []
}

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

A webhook payload

​
clientId
string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
notification
object

Detailed trade information including contract transactions

​
tenancyEnvironment
enum<string>

The tenancy environment of the trade.

Available options:
TEST,
LIVE
Example:

"TEST"

​
messageTraceId
string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
userId
null
​
userGroupTypes
string[]

The user group types.

​
notificationType
enum<string>
Available options:
stablefx.trade.refunded

Response

200

Webhook received successfully