Credit transfer state change

Sent when a credit transfer changes state. status is one of funds_reserved, requested, disbursed, past_due, paid, rejected, expired, or canceled.

WEBHOOK mintCreditTransfers

Example

{
  "subscriptionId": "00000000-0000-4000-8000-000000000002",
  "notificationId": "11111111-1111-4111-8111-111111111123",
  "notificationType": "mint.creditTransfers",
  "notification": {
    "id": "00000000-0000-4000-8000-000000000040",
    "amount": {
      "amount": "100000.00",
      "currency": "USD"
    },
    "status": "disbursed",
    "outstanding": {
      "amount": "95000.00",
      "currency": "USD"
    },
    "fees": {
      "total": {
        "amount": "5000.00",
        "currency": "USD"
      },
      "unpaid": {
        "amount": "2500.00",
        "currency": "USD"
      }
    },
    "dueDate": "2026-09-25T00:00:00.000Z",
    "disbursedDate": "2026-08-25T18:00:00.000Z",
    "paidDate": null,
    "expiresAt": null,
    "blockchainDestination": null,
    "createDate": "2026-08-25T17:00:00.000Z",
    "updateDate": "2026-08-25T18:00:00.000Z"
  },
  "timestamp": "2026-08-25T19:40:00.000000000Z",
  "version": 2
}

Body

application/json

The envelope every v2 webhook notification arrives in. The product-specific fields live in notification.

subscriptionId · string<uuid> · required

ID of the webhook subscription that produced this notification.

notificationId · string<uuid> · required

Unique ID for this event. Stable across retries of the same delivery, so use it to deduplicate.

notificationType · enum<string> · required

The type of notification.

Available options: mint.creditTransfers

notification · any · required

The event payload. The schema of this object depends on notificationType.

timestamp · string<date-time> · required

When the notification was produced.

version · integer · required

The version of the notification schema. Always 2.

Response

200

Webhook received successfully