{
  "id": "Webhook:019542f5-b3e7-1d02-0000-000000000040",
  "type": "SETTLEMENT_RULE.EXECUTED",
  "timestamp": "2026-11-06T18:00:03Z",
  "data": {
    "id": "SettlementRuleExecution:019542f5-b3e7-1d02-0000-000000000003",
    "settlementRuleId": "SettlementRule:019542f5-b3e7-1d02-0000-000000000001",
    "status": "EXECUTED",
    "incomingTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
    "creditedAccountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
    "incomingAmount": {
      "amount": 1000000,
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      }
    },
    "splitAmount": {
      "amount": 550000,
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      }
    },
    "payoutRunId": "PayoutRun:019542f5-b3e7-1d02-0000-000000000005",
    "incomingCompletedAt": "2026-11-06T18:00:00Z",
    "firesAt": "2026-11-06T18:00:00Z",
    "firstPaymentSentSeconds": 1.8,
    "lastPaymentSentSeconds": 2.6,
    "createdAt": "2026-11-06T18:00:00Z",
    "updatedAt": "2026-11-06T18:00:03Z"
  }
}

{
  "code": "INVALID_INPUT",
  "reason": "<string>",
  "details": {
    "errors": [
      {
        "field": "identifier",
        "constraint": {
          "format": "email",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "enum": [
            "SSN",
            "ITIN",
            "NON_US_TAX_ID"
          ],
          "minLength": 1,
          "maxLength": 500
        },
        "message": "Value is not one of the allowed enum members."
      }
    ],
    "missingRequirements": [
      "SUPPORTING_PROOF"
    ],
    "refusalReason": "AGENT_POLICY_DENIED",
    "missingFields": [
      "PHONE_NUMBER"
    ]
  }
}

{
  "code": "UNAUTHORIZED",
  "reason": "<string>",
  "details": {}
}

{
  "code": "TRANSACTION_NOT_PENDING_PLATFORM_APPROVAL",
  "reason": "<string>",
  "details": {}
}

Webhooks

Settlement rule execution finished webhook

Fired once when a settlement rule’s execution on an incoming payment finishes, with the execution:

SETTLEMENT_RULE.EXECUTED: its payout run finished COMPLETED or PARTIALLY_FAILED. payoutRunId names the run, whose own PAYOUT_RUN.* webhook carries the row counts.
SETTLEMENT_RULE.FAILED: its payout run finished FAILED, or was cancelled with POST /payout-runs/{payoutRunId}/cancel. The customer keeps what the run did not pay. A cancelled run still pays the shares whose payments had started; its rows say which.
SETTLEMENT_RULE.SKIPPED: nothing was paid; skipReason says why.

Each share’s transaction sends its own OUTGOING_PAYMENT.* webhooks. This endpoint should be implemented by clients of the Grid API.

Authentication

The webhook includes a signature in the X-Grid-Signature header that allows you to verify that the webhook was sent by Grid. To verify the signature:

Get the Grid public key provided to you during integration
Decode the base64 signature from the header
Create a SHA-256 hash of the request body
Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

WEBHOOK

settlement-rule

{
  "id": "Webhook:019542f5-b3e7-1d02-0000-000000000040",
  "type": "SETTLEMENT_RULE.EXECUTED",
  "timestamp": "2026-11-06T18:00:03Z",
  "data": {
    "id": "SettlementRuleExecution:019542f5-b3e7-1d02-0000-000000000003",
    "settlementRuleId": "SettlementRule:019542f5-b3e7-1d02-0000-000000000001",
    "status": "EXECUTED",
    "incomingTransactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
    "creditedAccountId": "InternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
    "incomingAmount": {
      "amount": 1000000,
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      }
    },
    "splitAmount": {
      "amount": 550000,
      "currency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      }
    },
    "payoutRunId": "PayoutRun:019542f5-b3e7-1d02-0000-000000000005",
    "incomingCompletedAt": "2026-11-06T18:00:00Z",
    "firesAt": "2026-11-06T18:00:00Z",
    "firstPaymentSentSeconds": 1.8,
    "lastPaymentSentSeconds": 2.6,
    "createdAt": "2026-11-06T18:00:00Z",
    "updatedAt": "2026-11-06T18:00:03Z"
  }
}

{
  "code": "INVALID_INPUT",
  "reason": "<string>",
  "details": {
    "errors": [
      {
        "field": "identifier",
        "constraint": {
          "format": "email",
          "pattern": "^\\d{5}(-\\d{4})?$",
          "enum": [
            "SSN",
            "ITIN",
            "NON_US_TAX_ID"
          ],
          "minLength": 1,
          "maxLength": 500
        },
        "message": "Value is not one of the allowed enum members."
      }
    ],
    "missingRequirements": [
      "SUPPORTING_PROOF"
    ],
    "refusalReason": "AGENT_POLICY_DENIED",
    "missingFields": [
      "PHONE_NUMBER"
    ]
  }
}

{
  "code": "UNAUTHORIZED",
  "reason": "<string>",
  "details": {}
}

{
  "code": "TRANSACTION_NOT_PENDING_PLATFORM_APPROVAL",
  "reason": "<string>",
  "details": {}
}

Authorizations

X-Grid-Signature

string

header

required

Secp256r1 (P-256) asymmetric signature of the webhook payload, which can be used to verify that the webhook was sent by Grid. To verify the signature:

Get the Grid public key provided to you during integration
Decode the base64 signature from the header
Create a SHA-256 hash of the request body
Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

Body

application/json

string

required

Unique identifier for this webhook delivery (can be used for idempotency)

Example:

"Webhook:019542f5-b3e7-1d02-0000-000000000007"

type

enum<string>

required

Status-specific event type in OBJECT.EVENT dot-notation (e.g., OUTGOING_PAYMENT.COMPLETED)

Available options:

SETTLEMENT_RULE.EXECUTED,

SETTLEMENT_RULE.FAILED,

SETTLEMENT_RULE.SKIPPED

timestamp

string<date-time>

required

ISO 8601 timestamp of when the webhook was sent

Example:

"2025-08-15T14:32:00Z"

data

object

required

Show child attributes

Response

Webhook received successfully

Using the API

API documentation

Settlement rule execution finished webhook

Authentication

Authorizations

Body

Response