Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.natural.co/llms.txt

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

Each event includes a type field describing what happened and a data.object containing a point-in-time snapshot of the resource. The full payload below is what your webhook endpoint receives.

wallet.created

A wallet was created for a party.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d221a",
  "object": "event",
  "type": "wallet.created",
  "resourceId": "wal_019cd3444a7a70efaf554fd8450d334b",
  "resourceType": "wallet",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "partyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
      "tier": "standard",
      "status": "active",
      "displayName": "My Wallet",
      "currency": "usd",
      "freezeDetails": null,
      "createdAt": "2026-01-15T14:30:00Z",
      "updatedAt": "2026-01-15T14:30:00Z",
      "createdBy": "usr_550e8400e29b41d4a716446655440000",
      "version": 1
    }
  }
}

party.updated

A party’s information was updated.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d221b",
  "object": "event",
  "type": "party.updated",
  "resourceId": "pty_019cd34e27bf78399b4e75b327d2ab25",
  "resourceType": "party",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "type": "org",
      "legalName": "Acme Corp",
      "displayName": "Acme",
      "status": "active",
      "email": "admin@acme.com",
      "createdAt": "2026-01-10T10:00:00Z",
      "updatedAt": "2026-01-15T14:30:00Z",
      "version": 3
    }
  }
}

party.delegation_granted

A delegation was granted to a party.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d221c",
  "object": "event",
  "type": "party.delegation_granted",
  "resourceId": "adl_019cd3444a7a70efaf554fd8450d445d",
  "resourceType": "delegation",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "delegatorPartyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
      "delegateePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
      "permissions": [
        "wallets.read",
        "wallets.create",
        "payments.create"
      ],
      "status": "active",
      "sourceType": "invitation",
      "createdAt": "2026-01-15T14:30:00Z",
      "version": 1
    }
  }
}

external_account.connected

An external bank account was linked.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d221d",
  "object": "event",
  "type": "external_account.connected",
  "resourceId": "eac_019cd3444a7a70efaf554fd8450d556e",
  "resourceType": "external_account",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "version": 1
    }
  }
}

agent_delegation_invitation.created

A developer created a per-agent invitation for a customer to accept.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2301",
  "object": "event",
  "type": "agent_delegation_invitation.created",
  "resourceId": "adi_019cd3444a7a70efaf554fd8450d4501",
  "resourceType": "agent_delegation_invitation",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "invitationId": "adi_019cd3444a7a70efaf554fd8450d4501",
      "agentId": "agt_019cd3444a7a70efaf554fd8450d4502",
      "delegateePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
      "delegatorPartyId": null,
      "customerEmail": "customer@example.com",
      "status": "pending",
      "permissions": [
        "payments.read",
        "payments.create"
      ],
      "limits": {
        "perTransactionCents": 50000
      },
      "expiresAt": "2026-02-15T14:30:00Z",
      "createdAt": "2026-01-15T14:30:00Z",
      "updatedAt": "2026-01-15T14:30:00Z",
      "version": 1
    }
  }
}

agent_delegation_invitation.accepted

A customer accepted a per-agent invitation; the per-agent grant is now active.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2302",
  "object": "event",
  "type": "agent_delegation_invitation.accepted",
  "resourceId": "adi_019cd3444a7a70efaf554fd8450d4501",
  "resourceType": "agent_delegation_invitation",
  "createdAt": "2026-01-15T15:00:00Z",
  "data": {
    "object": {
      "invitationId": "adi_019cd3444a7a70efaf554fd8450d4501",
      "agentId": "agt_019cd3444a7a70efaf554fd8450d4502",
      "delegateePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
      "delegatorPartyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
      "customerEmail": "customer@example.com",
      "status": "accepted",
      "permissions": [
        "payments.read",
        "payments.create"
      ],
      "limits": {
        "perTransactionCents": 50000
      },
      "expiresAt": "2026-02-15T14:30:00Z",
      "createdAt": "2026-01-15T14:30:00Z",
      "updatedAt": "2026-01-15T15:00:00Z",
      "version": 2
    }
  }
}

agent_delegation_invitation.declined

A customer declined a per-agent invitation.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2303",
  "object": "event",
  "type": "agent_delegation_invitation.declined",
  "resourceId": "adi_019cd3444a7a70efaf554fd8450d4501",
  "resourceType": "agent_delegation_invitation",
  "createdAt": "2026-01-15T15:00:00Z",
  "data": {
    "object": {
      "invitationId": "adi_019cd3444a7a70efaf554fd8450d4501",
      "agentId": "agt_019cd3444a7a70efaf554fd8450d4502",
      "delegateePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
      "delegatorPartyId": null,
      "customerEmail": "customer@example.com",
      "status": "declined",
      "permissions": [
        "payments.read",
        "payments.create"
      ],
      "limits": {
        "perTransactionCents": 50000
      },
      "expiresAt": "2026-02-15T14:30:00Z",
      "createdAt": "2026-01-15T14:30:00Z",
      "updatedAt": "2026-01-15T15:00:00Z",
      "version": 2
    }
  }
}

agent_delegation_invitation.cancelled

A pending per-agent invitation was cancelled (e.g. by agent or developer retire).
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2304",
  "object": "event",
  "type": "agent_delegation_invitation.cancelled",
  "resourceId": "adi_019cd3444a7a70efaf554fd8450d4501",
  "resourceType": "agent_delegation_invitation",
  "createdAt": "2026-01-15T15:00:00Z",
  "data": {
    "object": {
      "invitationId": "adi_019cd3444a7a70efaf554fd8450d4501",
      "agentId": "agt_019cd3444a7a70efaf554fd8450d4502",
      "delegateePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
      "delegatorPartyId": null,
      "customerEmail": "customer@example.com",
      "status": "cancelled",
      "permissions": [
        "payments.read",
        "payments.create"
      ],
      "limits": {
        "perTransactionCents": 50000
      },
      "expiresAt": "2026-02-15T14:30:00Z",
      "cancelReason": "developer_retired",
      "createdAt": "2026-01-15T14:30:00Z",
      "updatedAt": "2026-01-15T15:00:00Z",
      "version": 2
    }
  }
}

agent_delegation.revoked

A per-agent grant was revoked.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2305",
  "object": "event",
  "type": "agent_delegation.revoked",
  "resourceId": "adl_019cd3444a7a70efaf554fd8450d4503",
  "resourceType": "agent_delegation",
  "createdAt": "2026-01-15T16:00:00Z",
  "data": {
    "object": {
      "agentDelegationId": "adl_019cd3444a7a70efaf554fd8450d4503",
      "delegationId": "dlg_019cd3444a7a70efaf554fd8450d4504",
      "agentId": "agt_019cd3444a7a70efaf554fd8450d4502",
      "permissions": [
        "payments.read",
        "payments.create"
      ],
      "status": "revoked",
      "revokeReason": "customer",
      "createdAt": "2026-01-15T15:00:00Z",
      "updatedAt": "2026-01-15T16:00:00Z",
      "version": 2
    }
  }
}

delegation.activated

A parent delegation row went active (lazy creation on first agent accept).
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2306",
  "object": "event",
  "type": "delegation.activated",
  "resourceId": "dlg_019cd3444a7a70efaf554fd8450d4504",
  "resourceType": "delegation",
  "createdAt": "2026-01-15T15:00:00Z",
  "data": {
    "object": {
      "delegatorPartyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
      "delegateePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
      "permissions": [
        "payments.read",
        "payments.create"
      ],
      "status": "active",
      "sourceType": "invitation",
      "createdAt": "2026-01-15T15:00:00Z",
      "version": 1
    }
  }
}

delegation.revoked

A parent delegation row was revoked (last-active-agent cascade).
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2307",
  "object": "event",
  "type": "delegation.revoked",
  "resourceId": "dlg_019cd3444a7a70efaf554fd8450d4504",
  "resourceType": "delegation",
  "createdAt": "2026-01-15T16:00:00Z",
  "data": {
    "object": {
      "delegatorPartyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
      "delegateePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
      "permissions": [
        "payments.read",
        "payments.create"
      ],
      "status": "revoked",
      "sourceType": "invitation",
      "createdAt": "2026-01-15T15:00:00Z",
      "version": 2
    }
  }
}

deposit.created

A deposit was created — funds are being pulled into a wallet.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2401",
  "object": "event",
  "type": "deposit.created",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3401",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3401",
      "type": "deposit",
      "status": "created",
      "occurredAt": "2026-01-15T14:30:00Z",
      "lookupCode": "order-7731",
      "amount": {
        "minorUnits": "500000",
        "currency": "USD"
      },
      "rail": "ACH",
      "direction": "INBOUND"
    }
  }
}

deposit.completed

A deposit completed successfully; funds are available.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2402",
  "object": "event",
  "type": "deposit.completed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3401",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:35:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3401",
      "type": "deposit",
      "status": "completed",
      "occurredAt": "2026-01-15T14:35:00Z",
      "lookupCode": "order-7731"
    }
  }
}

deposit.failed

A deposit failed before settling.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2403",
  "object": "event",
  "type": "deposit.failed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3401",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:36:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3401",
      "type": "deposit",
      "status": "failed",
      "occurredAt": "2026-01-15T14:36:00Z",
      "lookupCode": "order-7731"
    }
  }
}

deposit.returned

A settled deposit was returned or reversed.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2404",
  "object": "event",
  "type": "deposit.returned",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3401",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-16T09:00:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3401",
      "type": "deposit",
      "status": "returned",
      "occurredAt": "2026-01-16T09:00:00Z",
      "lookupCode": "order-7731"
    }
  }
}

withdrawal.created

A withdrawal was created — funds are being moved out of a wallet.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2405",
  "object": "event",
  "type": "withdrawal.created",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3402",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3402",
      "type": "withdrawal",
      "status": "created",
      "occurredAt": "2026-01-15T14:30:00Z",
      "lookupCode": "payout-4410",
      "amount": {
        "minorUnits": "250000",
        "currency": "USD"
      },
      "rail": "ACH",
      "direction": "OUTBOUND"
    }
  }
}

withdrawal.completed

A withdrawal completed successfully.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2406",
  "object": "event",
  "type": "withdrawal.completed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3402",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:35:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3402",
      "type": "withdrawal",
      "status": "completed",
      "occurredAt": "2026-01-15T14:35:00Z",
      "lookupCode": "payout-4410"
    }
  }
}

withdrawal.failed

A withdrawal failed before settling.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2407",
  "object": "event",
  "type": "withdrawal.failed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3402",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:36:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3402",
      "type": "withdrawal",
      "status": "failed",
      "occurredAt": "2026-01-15T14:36:00Z",
      "lookupCode": "payout-4410"
    }
  }
}

withdrawal.returned

A settled withdrawal was returned or reversed.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2408",
  "object": "event",
  "type": "withdrawal.returned",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3402",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-16T09:00:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3402",
      "type": "withdrawal",
      "status": "returned",
      "occurredAt": "2026-01-16T09:00:00Z",
      "lookupCode": "payout-4410"
    }
  }
}

payment.created

A payment was created — a wallet-to-wallet transfer is in progress.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2409",
  "object": "event",
  "type": "payment.created",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3403",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3403",
      "type": "payment",
      "status": "created",
      "occurredAt": "2026-01-15T14:30:00Z",
      "lookupCode": "invoice-2208",
      "amount": {
        "minorUnits": "150000",
        "currency": "USD"
      },
      "rail": "PROVIDER_BOOK",
      "direction": "INTERNAL"
    }
  }
}

payment.completed

A payment completed successfully.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2410",
  "object": "event",
  "type": "payment.completed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3403",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:30:05Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3403",
      "type": "payment",
      "status": "completed",
      "occurredAt": "2026-01-15T14:30:05Z",
      "lookupCode": "invoice-2208"
    }
  }
}

payment.failed

A payment failed.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2411",
  "object": "event",
  "type": "payment.failed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3403",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:30:06Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3403",
      "type": "payment",
      "status": "failed",
      "occurredAt": "2026-01-15T14:30:06Z",
      "lookupCode": "invoice-2208"
    }
  }
}

payment_request.created

A payment request was created.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2412",
  "object": "event",
  "type": "payment_request.created",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3404",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3404",
      "type": "payment_request",
      "status": "created",
      "occurredAt": "2026-01-15T14:30:00Z",
      "lookupCode": "request-9930",
      "amount": {
        "minorUnits": "300000",
        "currency": "USD"
      },
      "rail": "ACH",
      "direction": "INBOUND"
    }
  }
}

payment_request.completed

A payment request was fulfilled.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2413",
  "object": "event",
  "type": "payment_request.completed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3404",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T18:30:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3404",
      "type": "payment_request",
      "status": "completed",
      "occurredAt": "2026-01-15T18:30:00Z",
      "lookupCode": "request-9930"
    }
  }
}

payment_request.failed

A payment request failed.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2414",
  "object": "event",
  "type": "payment_request.failed",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3404",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-15T14:31:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3404",
      "type": "payment_request",
      "status": "failed",
      "occurredAt": "2026-01-15T14:31:00Z",
      "lookupCode": "request-9930"
    }
  }
}

payment_request.returned

A fulfilled payment request was returned or reversed.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2415",
  "object": "event",
  "type": "payment_request.returned",
  "resourceId": "mmr_019cd3444a7a70efaf554fd8450d3404",
  "resourceType": "money_movement_request",
  "createdAt": "2026-01-17T09:00:00Z",
  "data": {
    "object": {
      "id": "mmr_019cd3444a7a70efaf554fd8450d3404",
      "type": "payment_request",
      "status": "returned",
      "occurredAt": "2026-01-17T09:00:00Z",
      "lookupCode": "request-9930"
    }
  }
}

payment_request.incoming

A payment request was created naming this party as the payer.
{
  "id": "evt_019cd3444a7a70efaf554fd8450d2500",
  "object": "event",
  "type": "payment_request.incoming",
  "resourceId": "prq_019cd3444a7a70efaf554fd8450d3500",
  "resourceType": "payment_request",
  "createdAt": "2026-01-15T14:30:00Z",
  "data": {
    "object": {
      "id": "prq_019cd3444a7a70efaf554fd8450d3500",
      "type": "payment_request",
      "status": "OPEN",
      "occurredAt": "2026-01-15T14:30:00Z",
      "amount": {
        "minorUnits": "500",
        "currency": "USD"
      },
      "description": "Invoice 7",
      "payeePartyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
      "payerPartyId": "pty_019cd3444a7a70efaf554fd8450d3501"
    }
  }
}