Claimable payout webhook

Fired when a claimable payout is claimed, paid, expires or fails, so the platform can tell the sender. CLAIMABLE_PAYOUT.EXPIRED and CLAIMABLE_PAYOUT.FAILED mean the hold on the sender’s wallet was released. 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:

1. Get the Grid public key provided to you during integration
2. Decode the base64 signature from the header
3. Create a SHA-256 hash of the request body
4. 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 claimable-payout

paid

{
  "id": "Webhook:019542f5-b3e7-1d02-0000-000000000021",
  "type": "CLAIMABLE_PAYOUT.PAID",
  "timestamp": "2025-10-04T09:00:00Z",
  "data": {
    "id": "ClaimablePayout:019542f5-b3e7-1d02-0000-000000000077",
    "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000042",
    "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000010",
    "platformCustomerId": "user-a1b2c3",
    "status": "PAID",
    "sourceAccountId": "InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123",
    "amount": {
      "amount": 5000,
      "currency": {
        "code": "USDB",
        "name": "USDB",
        "symbol": "$",
        "decimals": 2
      }
    },
    "recipient": {
      "name": "Maria",
      "phoneNumber": "[phone]",
      "country": "PH"
    },
    "externalAccountId": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965",
    "transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000030",
    "receivedAmount": {
      "amount": 287000,
      "currency": {
        "code": "PHP",
        "name": "Philippine Peso",
        "symbol": "₱",
        "decimals": 2
      }
    },
    "paymentRail": "MOBILE_MONEY",
    "expiresAt": "2025-10-10T15:00:00Z",
    "createdAt": "2025-10-03T15:00:00Z",
    "updatedAt": "2025-10-04T09:00:00Z"
  }
}

400

{
  "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"
    ]
  }
}

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:

1. Get the Grid public key provided to you during integration
2. Decode the base64 signature from the header
3. Create a SHA-256 hash of the request body
4. 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

id · 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: CLAIMABLE_PAYOUT.CLAIMED, CLAIMABLE_PAYOUT.PAID, CLAIMABLE_PAYOUT.EXPIRED, CLAIMABLE_PAYOUT.FAILED

timestamp · string<date-time> · required

ISO 8601 timestamp of when the webhook was sent

Example:

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

data · object · required

Money an agent sends to a person by phone number or email, for her to claim from a link. Grid holds amount against the sender's Embedded Wallet balance and the agent's spending limits; the funds stay in the wallet until the recipient claims and Grid pays her from it.

Show child attributes

Response

200

Webhook received successfully