> ## Documentation Index
> Fetch the complete documentation index at: https://docs.natural.com/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> When building application code, use `@naturalpay/sdk` for TypeScript or `naturalpay` for Python.
> When operating Natural directly for a user, use the payments MCP at `https://mcp.natural.com`.
> When searching Natural documentation, use the docs MCP at `https://docs.natural.com/mcp`.
> Use the Natural CLI for terminal and CI automation.
> Use REST only for unsupported languages or when the user explicitly requests raw HTTP.
> Start integration development and testing in the sandbox. Do not use production unless the user explicitly requests it.
> For sandbox requests that require `customerPartyId`, list customers first. Reuse only the intended fixture; otherwise create a customer.
> REST and SDK amounts use integer minor units. Payments MCP amounts use decimal strings with a required currency code.
# Event types
> Complete reference of all webhook event types and their payloads
Each event includes a `type` field describing what happened and a `data.object` containing a point-in-time snapshot of the resource. Expand an event to see the full payload your webhook endpoint receives.
## Payments
A payment resource was created before approval or money movement submission. The fee is assessed when the payment is sent, so it's always null on `payment.created`. Only the sender's copy carries it. Payments that pay a payment request never carry a fee; the request fee is on `payment_request.completed`.
```json theme={null}
{
"id": "evt_00000000000000000000000000002001",
"object": "event",
"type": "payment.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "pay_00000000000000000000000000000001",
"resourceType": "payment",
"createdAt": "2026-06-13T12:00:00Z",
"data": {
"object": {
"type": "payment",
"id": "pay_00000000000000000000000000000001",
"attributes": {
"amount": 2500,
"currency": "usd",
"status": "CREATED",
"description": "Payment",
"tags": {
"order_id": "ord_123"
},
"fee": null,
"submittedAt": null,
"terminalAt": null,
"failure": null,
"return": null,
"claim": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:00:00.000Z"
},
"relationships": {
"sender": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"recipient": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"recipientAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000012"
}
},
"transaction": {
"data": null
},
"paymentRequest": {
"data": null
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 1
}
}
}
```
A payment reached the public completed state.
```json theme={null}
{
"id": "evt_00000000000000000000000000002002",
"object": "event",
"type": "payment.completed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "pay_00000000000000000000000000000001",
"resourceType": "payment",
"createdAt": "2026-06-13T12:05:00Z",
"data": {
"object": {
"type": "payment",
"id": "pay_00000000000000000000000000000001",
"attributes": {
"amount": 2500,
"currency": "usd",
"status": "COMPLETED",
"description": "Payment request fulfillment",
"tags": {
"invoice_id": "inv_123"
},
"fee": null,
"submittedAt": "2026-06-13T12:01:00.000Z",
"terminalAt": "2026-06-13T12:05:00.000Z",
"failure": null,
"return": null,
"claim": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:05:00.000Z"
},
"relationships": {
"sender": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"recipient": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"recipientAgent": {
"data": null
},
"transaction": {
"data": null
},
"paymentRequest": {
"data": {
"type": "paymentRequest",
"id": "prq_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
}
},
"version": 3
}
}
}
```
A payment failed during submit or money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000002003",
"object": "event",
"type": "payment.failed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "pay_00000000000000000000000000000002",
"resourceType": "payment",
"createdAt": "2026-06-13T12:05:00Z",
"data": {
"object": {
"type": "payment",
"id": "pay_00000000000000000000000000000002",
"attributes": {
"amount": 5000,
"currency": "usd",
"status": "FAILED",
"description": null,
"tags": {
"order_id": "ord_123"
},
"fee": null,
"submittedAt": "2026-06-13T12:01:00.000Z",
"terminalAt": "2026-06-13T12:05:00.000Z",
"failure": {
"code": "INSUFFICIENT_FUNDS",
"reason": "insufficient_funds"
},
"return": null,
"claim": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:05:00.000Z"
},
"relationships": {
"sender": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"recipient": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"recipientAgent": {
"data": null
},
"transaction": {
"data": null
},
"paymentRequest": {
"data": null
},
"initiatorAgent": {
"data": null
}
},
"version": 3
}
}
}
```
A completed return-capable payment was returned.
```json theme={null}
{
"id": "evt_00000000000000000000000000002006",
"object": "event",
"type": "payment.returned",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "pay_00000000000000000000000000000001",
"resourceType": "payment",
"createdAt": "2026-06-14T12:05:00Z",
"data": {
"object": {
"type": "payment",
"id": "pay_00000000000000000000000000000001",
"attributes": {
"amount": 2500,
"currency": "usd",
"status": "RETURNED",
"description": "Payment request fulfillment",
"tags": {
"invoice_id": "inv_123"
},
"fee": null,
"submittedAt": "2026-06-13T12:01:00.000Z",
"terminalAt": "2026-06-14T12:05:00.000Z",
"failure": null,
"return": {
"code": "R01",
"reason": "Insufficient funds"
},
"claim": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-14T12:05:00.000Z"
},
"relationships": {
"sender": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"recipient": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"recipientAgent": {
"data": null
},
"transaction": {
"data": null
},
"paymentRequest": {
"data": {
"type": "paymentRequest",
"id": "prq_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
}
},
"version": 4
}
}
}
```
A payment was canceled before money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000002004",
"object": "event",
"type": "payment.canceled",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "pay_00000000000000000000000000000003",
"resourceType": "payment",
"createdAt": "2026-06-13T12:03:00Z",
"data": {
"object": {
"type": "payment",
"id": "pay_00000000000000000000000000000003",
"attributes": {
"amount": 2500,
"currency": "usd",
"status": "CANCELED",
"description": null,
"tags": {
"order_id": "ord_123"
},
"fee": null,
"submittedAt": null,
"terminalAt": "2026-06-13T12:03:00.000Z",
"failure": {
"code": null,
"reason": "policy_canceled"
},
"return": null,
"claim": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:03:00.000Z"
},
"relationships": {
"sender": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"recipient": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"recipientAgent": {
"data": null
},
"transaction": {
"data": null
},
"paymentRequest": {
"data": null
},
"initiatorAgent": {
"data": null
}
},
"version": 2
}
}
}
```
A payment approval was explicitly denied before money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000002005",
"object": "event",
"type": "payment.approval_denied",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "pay_00000000000000000000000000000004",
"resourceType": "payment",
"createdAt": "2026-06-13T12:04:00Z",
"data": {
"object": {
"type": "payment",
"id": "pay_00000000000000000000000000000004",
"attributes": {
"amount": 2500,
"currency": "usd",
"status": "APPROVAL_DENIED",
"description": null,
"tags": {
"order_id": "ord_123"
},
"fee": null,
"submittedAt": null,
"terminalAt": "2026-06-13T12:04:00.000Z",
"failure": {
"code": null,
"reason": "risk_policy_denied"
},
"return": null,
"claim": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:04:00.000Z"
},
"relationships": {
"sender": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"recipient": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"recipientAgent": {
"data": null
},
"transaction": {
"data": null
},
"paymentRequest": {
"data": null
},
"initiatorAgent": {
"data": null
}
},
"version": 2
}
}
}
```
## Payment intents
A payment intent was paid in full by a succeeded card payment.
```json theme={null}
{
"id": "evt_00000000000000000000000000008001",
"object": "event",
"type": "paymentIntent.completed",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "pmi_00000000000000000000000000000001",
"resourceType": "paymentIntent",
"createdAt": "2026-09-13T12:00:05Z",
"data": {
"object": {
"id": "pmi_00000000000000000000000000000001",
"type": "paymentIntent",
"attributes": {
"amount": 500,
"currency": "USD",
"description": "Order 1042",
"payUrl": null,
"status": "completed",
"taxMode": "exclusive",
"taxAmount": 0,
"lineItems": [
{
"id": "pli_00000000000000000000000000000001",
"position": 0,
"referenceId": "SKU-1042",
"description": "Widget",
"quantity": 1,
"unitAmount": 500,
"subtotalAmount": 500,
"taxAmount": 0,
"totalAmount": 500,
"taxCode": null
}
],
"expiresAt": null,
"canceledAt": null,
"createdAt": "2026-09-13T11:59:00Z",
"updatedAt": "2026-09-13T12:00:05Z"
},
"relationships": {
"cardPayment": {
"data": {
"type": "cardPayment",
"id": "cpy_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
},
"voiceSession": {
"data": null
}
},
"version": 3
}
}
}
```
An open payment intent was canceled.
```json theme={null}
{
"id": "evt_00000000000000000000000000008004",
"object": "event",
"type": "paymentIntent.canceled",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "pmi_00000000000000000000000000000001",
"resourceType": "paymentIntent",
"createdAt": "2026-09-13T12:10:00Z",
"data": {
"object": {
"id": "pmi_00000000000000000000000000000001",
"type": "paymentIntent",
"attributes": {
"amount": 500,
"currency": "USD",
"description": "Order 1042",
"payUrl": null,
"status": "canceled",
"taxMode": "exclusive",
"taxAmount": 0,
"lineItems": [
{
"id": "pli_00000000000000000000000000000001",
"position": 0,
"referenceId": "SKU-1042",
"description": "Widget",
"quantity": 1,
"unitAmount": 500,
"subtotalAmount": 500,
"taxAmount": 0,
"totalAmount": 500,
"taxCode": null
}
],
"expiresAt": null,
"canceledAt": "2026-09-13T12:10:00Z",
"createdAt": "2026-09-13T11:59:00Z",
"updatedAt": "2026-09-13T12:10:00Z"
},
"relationships": {
"cardPayment": {
"data": null
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
},
"voiceSession": {
"data": null
}
},
"version": 2
}
}
}
```
## Card payments
A card payment was submitted and is processing. The fee is assessed when the card is authorized, so it's always null on `cardPayment.created`. Read it from `cardPayment.succeeded`.
```json theme={null}
{
"id": "evt_00000000000000000000000000008005",
"object": "event",
"type": "cardPayment.created",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "cpy_00000000000000000000000000000001",
"resourceType": "cardPayment",
"createdAt": "2026-09-13T12:00:00Z",
"data": {
"object": {
"id": "cpy_00000000000000000000000000000001",
"type": "cardPayment",
"attributes": {
"amount": 500,
"currency": "USD",
"status": "processing",
"brand": "visa",
"last4": "4242",
"channel": "voice",
"receiptUrl": null,
"failure": null,
"fee": null,
"refundedAmount": 0,
"refundableAmount": 0,
"settledAt": null,
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:00:00Z"
},
"relationships": {
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"refunds": {
"data": []
}
},
"version": 1
}
}
}
```
A card payment was approved by the card network.
```json theme={null}
{
"id": "evt_00000000000000000000000000008002",
"object": "event",
"type": "cardPayment.succeeded",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "cpy_00000000000000000000000000000001",
"resourceType": "cardPayment",
"createdAt": "2026-09-13T12:00:05Z",
"data": {
"object": {
"id": "cpy_00000000000000000000000000000001",
"type": "cardPayment",
"attributes": {
"amount": 500,
"currency": "USD",
"status": "succeeded",
"brand": "visa",
"last4": "4242",
"channel": "voice",
"receiptUrl": "https://accept.natural.com/receipts#Qm9vazJoYXNoYnJvd25zMg",
"failure": null,
"fee": {
"amount": 45,
"currency": "USD",
"payer": "recipient",
"applied": "deducted"
},
"refundedAmount": 0,
"refundableAmount": 500,
"settledAt": null,
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:00:05Z"
},
"relationships": {
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"refunds": {
"data": []
}
},
"version": 3
}
}
}
```
A card payment was declined or could not be processed.
```json theme={null}
{
"id": "evt_00000000000000000000000000008003",
"object": "event",
"type": "cardPayment.failed",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "cpy_00000000000000000000000000000001",
"resourceType": "cardPayment",
"createdAt": "2026-09-13T12:00:05Z",
"data": {
"object": {
"id": "cpy_00000000000000000000000000000001",
"type": "cardPayment",
"attributes": {
"amount": 500,
"currency": "USD",
"status": "failed",
"brand": "visa",
"last4": "4242",
"channel": "voice",
"receiptUrl": null,
"failure": {
"code": "insufficientFunds",
"reason": "The card has insufficient funds.",
"advice": "tryAgainLater"
},
"fee": null,
"refundedAmount": 0,
"refundableAmount": 0,
"settledAt": null,
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:00:05Z"
},
"relationships": {
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"refunds": {
"data": []
}
},
"version": 3
}
}
}
```
## Voice sessions
A voice session completed: the call has ended and its result is known. It does not mean paid. Read `payment.outcome`: `paid`, `linkSent` when voice payment did not succeed and the caller was texted the payment link, or `unpaid`. Money arrives on `paymentIntent.completed`.
```json theme={null}
{
"id": "evt_00000000000000000000000000008101",
"object": "event",
"type": "voiceSession.completed",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "vos_00000000000000000000000000000001",
"resourceType": "voiceSession",
"createdAt": "2026-09-13T12:03:05Z",
"data": {
"object": {
"id": "vos_00000000000000000000000000000001",
"type": "voiceSession",
"attributes": {
"kind": "payment",
"status": "ended",
"referenceId": "call_8842",
"callerPhone": "+14155550123",
"dialUri": null,
"dialExpiresAt": "2026-09-13T12:15:00.000Z",
"returnTarget": "sip:agent-9920@sip.partner.example.com",
"call": {
"startedAt": "2026-09-13T12:00:20.000Z",
"endedAt": "2026-09-13T12:03:05.000Z",
"durationSeconds": 165,
"endedBy": "assistant",
"summary": "Two card declines. The caller was texted the payment link.",
"returnRequestedAt": null
},
"completedAt": "2026-09-13T12:03:05.000Z",
"payment": {
"outcome": "linkSent",
"linkSentAt": "2026-09-13T12:02:41.000Z",
"failedAttempts": 2,
"failure": {
"code": "insufficientFunds",
"reason": "The card has insufficient funds.",
"advice": "tryAgainLater"
}
},
"createdAt": "2026-09-13T12:00:00.000Z",
"updatedAt": "2026-09-13T12:03:05.000Z"
},
"relationships": {
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
}
},
"version": 5
}
}
}
```
## Refunds
A refund was requested and is pending.
```json theme={null}
{
"id": "evt_00000000000000000000000000009001",
"object": "event",
"type": "refund.created",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "rfd_00000000000000000000000000000001",
"resourceType": "refund",
"createdAt": "2026-09-13T12:00:00Z",
"data": {
"object": {
"id": "rfd_00000000000000000000000000000001",
"type": "refund",
"attributes": {
"amount": 500,
"currency": "USD",
"reason": "requestedByPayer",
"status": "pending",
"failure": null,
"receiptUrl": "https://accept.natural.com/receipts#Qm9vazJoYXNoYnJvd25zMg",
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:00:00Z"
},
"relationships": {
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"cardPayment": {
"data": {
"type": "cardPayment",
"id": "cpy_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
}
},
"version": 2
}
}
}
```
A refund was processed by the card network.
```json theme={null}
{
"id": "evt_00000000000000000000000000009002",
"object": "event",
"type": "refund.succeeded",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "rfd_00000000000000000000000000000001",
"resourceType": "refund",
"createdAt": "2026-09-13T12:05:00Z",
"data": {
"object": {
"id": "rfd_00000000000000000000000000000001",
"type": "refund",
"attributes": {
"amount": 500,
"currency": "USD",
"reason": "requestedByPayer",
"status": "succeeded",
"failure": null,
"receiptUrl": "https://accept.natural.com/receipts#Qm9vazJoYXNoYnJvd25zMg",
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:05:00Z"
},
"relationships": {
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"cardPayment": {
"data": {
"type": "cardPayment",
"id": "cpy_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
}
},
"version": 2
}
}
}
```
A refund was declined or could not be processed.
```json theme={null}
{
"id": "evt_00000000000000000000000000009003",
"object": "event",
"type": "refund.failed",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "rfd_00000000000000000000000000000001",
"resourceType": "refund",
"createdAt": "2026-09-13T12:05:00Z",
"data": {
"object": {
"id": "rfd_00000000000000000000000000000001",
"type": "refund",
"attributes": {
"amount": 500,
"currency": "USD",
"reason": "requestedByPayer",
"status": "failed",
"failure": {
"code": "declined",
"reason": null
},
"receiptUrl": "https://accept.natural.com/receipts#Qm9vazJoYXNoYnJvd25zMg",
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:05:00Z"
},
"relationships": {
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"cardPayment": {
"data": {
"type": "cardPayment",
"id": "cpy_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
}
},
"version": 2
}
}
}
```
## Chargebacks
A chargeback case was opened against a card payment. The fee is billed when the case opens, so it's already on `chargeback.created`.
```json theme={null}
{
"id": "evt_00000000000000000000000000009101",
"object": "event",
"type": "chargeback.created",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "cbk_00000000000000000000000000000001",
"resourceType": "chargeback",
"createdAt": "2026-09-13T12:00:00Z",
"data": {
"object": {
"id": "cbk_00000000000000000000000000000001",
"type": "chargeback",
"attributes": {
"amount": 500,
"currency": "USD",
"fee": {
"amount": 1500,
"currency": "USD"
},
"status": "needsResponse",
"network": "visa",
"reason": {
"category": "notReceived",
"networkCode": "13.1",
"description": "Merchandise or services not received"
},
"responseDueAt": "2026-09-20T23:59:59Z",
"submittedAt": null,
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:00:00Z"
},
"relationships": {
"cardPayment": {
"data": {
"type": "cardPayment",
"id": "cpy_00000000000000000000000000000001"
}
},
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
}
}
}
}
}
```
A chargeback case moved: accepted, representment submitted, acknowledged, or the response window expired.
```json theme={null}
{
"id": "evt_00000000000000000000000000009102",
"object": "event",
"type": "chargeback.updated",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "cbk_00000000000000000000000000000001",
"resourceType": "chargeback",
"createdAt": "2026-09-13T12:05:00Z",
"data": {
"object": {
"id": "cbk_00000000000000000000000000000001",
"type": "chargeback",
"attributes": {
"amount": 500,
"currency": "USD",
"fee": {
"amount": 1500,
"currency": "USD"
},
"status": "accepted",
"network": "visa",
"reason": {
"category": "notReceived",
"networkCode": "13.1",
"description": "Merchandise or services not received"
},
"responseDueAt": "2026-09-20T23:59:59Z",
"submittedAt": null,
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-09-13T12:05:00Z"
},
"relationships": {
"cardPayment": {
"data": {
"type": "cardPayment",
"id": "cpy_00000000000000000000000000000001"
}
},
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
}
}
}
}
}
```
A chargeback case closed with a result.
```json theme={null}
{
"id": "evt_00000000000000000000000000009107",
"object": "event",
"type": "chargeback.closed",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "cbk_00000000000000000000000000000001",
"resourceType": "chargeback",
"createdAt": "2026-10-01T12:00:00Z",
"data": {
"object": {
"id": "cbk_00000000000000000000000000000001",
"type": "chargeback",
"attributes": {
"amount": 500,
"currency": "USD",
"fee": {
"amount": 1500,
"currency": "USD"
},
"status": "won",
"network": "visa",
"reason": {
"category": "notReceived",
"networkCode": "13.1",
"description": "Merchandise or services not received"
},
"responseDueAt": "2026-09-20T23:59:59Z",
"submittedAt": "2026-09-13T12:05:00Z",
"createdAt": "2026-09-13T12:00:00Z",
"updatedAt": "2026-10-01T12:00:00Z"
},
"relationships": {
"cardPayment": {
"data": {
"type": "cardPayment",
"id": "cpy_00000000000000000000000000000001"
}
},
"paymentIntent": {
"data": {
"type": "paymentIntent",
"id": "pmi_00000000000000000000000000000001"
}
},
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000011"
}
}
}
}
}
}
```
## Enrollment
A merchant submitted an Accept application.
```json theme={null}
{
"id": "evt_0000000000000000000000000000a101",
"object": "event",
"type": "enrollment.applied",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"resourceType": "enrollment",
"createdAt": "2026-09-13T12:00:00Z",
"data": {
"object": {
"id": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"type": "enrollment",
"merchantId": "pty_00000000000000000000000000000011",
"product": "accept",
"status": "applied",
"appliedAt": "2026-09-13T12:00:00Z",
"boardingCompletedAt": null,
"createdAt": "2026-09-13T11:00:00Z",
"updatedAt": "2026-09-13T12:00:00Z",
"version": 2
}
}
}
```
An Accept application was approved and the merchant can accept payments.
```json theme={null}
{
"id": "evt_0000000000000000000000000000a102",
"object": "event",
"type": "enrollment.activated",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"resourceType": "enrollment",
"createdAt": "2026-09-14T10:00:00Z",
"data": {
"object": {
"id": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"type": "enrollment",
"merchantId": "pty_00000000000000000000000000000011",
"product": "accept",
"status": "active",
"appliedAt": "2026-09-13T12:00:00Z",
"boardingCompletedAt": "2026-09-14T09:00:00Z",
"createdAt": "2026-09-13T11:00:00Z",
"updatedAt": "2026-09-14T10:00:00Z",
"version": 5
}
}
}
```
An Accept application was rejected.
```json theme={null}
{
"id": "evt_0000000000000000000000000000a103",
"object": "event",
"type": "enrollment.rejected",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"resourceType": "enrollment",
"createdAt": "2026-09-14T10:00:00Z",
"data": {
"object": {
"id": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"type": "enrollment",
"merchantId": "pty_00000000000000000000000000000011",
"product": "accept",
"status": "rejected",
"appliedAt": "2026-09-13T12:00:00Z",
"boardingCompletedAt": null,
"createdAt": "2026-09-13T11:00:00Z",
"updatedAt": "2026-09-14T10:00:00Z",
"version": 3
}
}
}
```
An Accept enrollment was closed; the party is no longer a merchant.
```json theme={null}
{
"id": "evt_0000000000000000000000000000a104",
"object": "event",
"type": "enrollment.offboarded",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"resourceType": "enrollment",
"createdAt": "2026-09-20T10:00:00Z",
"data": {
"object": {
"id": "6f1c2b3a-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"type": "enrollment",
"merchantId": "pty_00000000000000000000000000000011",
"product": "accept",
"status": "offboarded",
"appliedAt": "2026-09-13T12:00:00Z",
"boardingCompletedAt": "2026-09-14T09:00:00Z",
"createdAt": "2026-09-13T11:00:00Z",
"updatedAt": "2026-09-20T10:00:00Z",
"version": 6
}
}
}
```
## ACH
An ACH transfer resource was created. The fee is assessed when the transfer is submitted, so it's always null on `ach.created`. Read it from `ach.processing`.
```json theme={null}
{
"id": "evt_00000000000000000000000000003001",
"object": "event",
"type": "ach.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ach_00000000000000000000000000000001",
"resourceType": "ach",
"createdAt": "2026-08-11T12:00:00Z",
"data": {
"object": {
"type": "ach",
"id": "ach_00000000000000000000000000000001",
"attributes": {
"direction": "debit",
"amount": 12500,
"currency": "USD",
"fee": null,
"status": "CREATED",
"companyEntryDescription": "INVOICE",
"internalDescription": "Q3 vendor true-up",
"addenda": null,
"secCode": "WEB",
"submittedDescriptor": {
"companyName": "Natural Test",
"companyEntryDescription": "INVOICE"
},
"traceNumber": null,
"failure": null,
"return": null,
"submittedAt": null,
"settledAt": null,
"expectedAvailableAt": null,
"terminalAt": null,
"createdAt": "2026-08-11T12:00:00.000Z",
"updatedAt": "2026-08-11T12:00:00.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"mandate": {
"data": {
"type": "mandate",
"id": "mdt_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 1
}
}
}
```
An ACH transfer was submitted to money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000003006",
"object": "event",
"type": "ach.processing",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ach_00000000000000000000000000000001",
"resourceType": "ach",
"createdAt": "2026-08-11T12:01:00Z",
"data": {
"object": {
"type": "ach",
"id": "ach_00000000000000000000000000000001",
"attributes": {
"direction": "credit",
"amount": 12500,
"currency": "USD",
"fee": {
"amount": 25,
"currency": "USD",
"payer": "sender",
"applied": "on_top"
},
"status": "PROCESSING",
"companyEntryDescription": "INVOICE",
"internalDescription": null,
"addenda": null,
"secCode": "WEB",
"submittedDescriptor": {
"companyName": "Natural Test",
"companyEntryDescription": "INVOICE"
},
"traceNumber": "123456780000001",
"failure": null,
"return": null,
"submittedAt": "2026-08-11T12:01:00.000Z",
"settledAt": null,
"expectedAvailableAt": "2026-08-12T12:00:00.000Z",
"terminalAt": null,
"createdAt": "2026-08-11T12:00:00.000Z",
"updatedAt": "2026-08-11T12:01:00.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"mandate": {
"data": null
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 2
}
}
}
```
An ACH transfer settled at the receiving bank. Settlement is the resting state; a return can still arrive afterward.
```json theme={null}
{
"id": "evt_00000000000000000000000000003003",
"object": "event",
"type": "ach.settled",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ach_00000000000000000000000000000001",
"resourceType": "ach",
"createdAt": "2026-08-12T12:00:00Z",
"data": {
"object": {
"type": "ach",
"id": "ach_00000000000000000000000000000001",
"attributes": {
"direction": "debit",
"amount": 12500,
"currency": "USD",
"fee": null,
"status": "SETTLED",
"companyEntryDescription": "INVOICE",
"internalDescription": null,
"addenda": "TXP*12345678*94105*260917*10000",
"secCode": "WEB",
"submittedDescriptor": {
"companyName": "Natural Test",
"companyEntryDescription": "INVOICE"
},
"traceNumber": "123456780000001",
"failure": null,
"return": null,
"submittedAt": "2026-08-11T12:01:00.000Z",
"settledAt": "2026-08-12T12:00:00.000Z",
"expectedAvailableAt": "2026-08-12T12:00:00.000Z",
"terminalAt": "2026-08-12T12:00:00.000Z",
"createdAt": "2026-08-11T12:00:00.000Z",
"updatedAt": "2026-08-12T12:00:00.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"mandate": {
"data": {
"type": "mandate",
"id": "mdt_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 3
}
}
}
```
An ACH transfer failed before completion.
```json theme={null}
{
"id": "evt_00000000000000000000000000003004",
"object": "event",
"type": "ach.failed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ach_00000000000000000000000000000002",
"resourceType": "ach",
"createdAt": "2026-08-11T12:02:00Z",
"data": {
"object": {
"type": "ach",
"id": "ach_00000000000000000000000000000002",
"attributes": {
"direction": "credit",
"amount": 12500,
"currency": "USD",
"fee": null,
"status": "FAILED",
"companyEntryDescription": "PAYROLL",
"internalDescription": null,
"addenda": null,
"secCode": "PPD",
"submittedDescriptor": {
"companyName": "Natural Test",
"companyEntryDescription": "PAYROLL"
},
"traceNumber": null,
"failure": {
"reason": "Bank account could not receive the credit.",
"code": "R03"
},
"return": null,
"submittedAt": "2026-08-11T12:01:00.000Z",
"settledAt": null,
"expectedAvailableAt": null,
"terminalAt": "2026-08-11T12:02:00.000Z",
"createdAt": "2026-08-11T12:00:00.000Z",
"updatedAt": "2026-08-11T12:02:00.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"mandate": {
"data": null
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 3
}
}
}
```
An ACH transfer was returned or reversed.
```json theme={null}
{
"id": "evt_00000000000000000000000000003005",
"object": "event",
"type": "ach.returned",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ach_00000000000000000000000000000001",
"resourceType": "ach",
"createdAt": "2026-08-13T12:00:00Z",
"data": {
"object": {
"type": "ach",
"id": "ach_00000000000000000000000000000001",
"attributes": {
"direction": "debit",
"amount": 12500,
"currency": "USD",
"fee": null,
"status": "RETURNED",
"companyEntryDescription": "INVOICE",
"internalDescription": null,
"addenda": null,
"secCode": "WEB",
"submittedDescriptor": {
"companyName": "Natural Test",
"companyEntryDescription": "INVOICE"
},
"traceNumber": "123456780000001",
"failure": null,
"return": {
"code": "R01",
"reason": "Insufficient funds",
"returnedAt": "2026-08-13T12:00:00.000Z",
"dishonoredAt": null,
"contestedAt": null,
"fundsUnlockedAt": "2026-08-13T12:05:00.000Z"
},
"submittedAt": "2026-08-11T12:01:00.000Z",
"settledAt": "2026-08-12T12:00:00.000Z",
"expectedAvailableAt": null,
"terminalAt": "2026-08-13T12:00:00.000Z",
"createdAt": "2026-08-11T12:00:00.000Z",
"updatedAt": "2026-08-13T12:00:00.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"mandate": {
"data": {
"type": "mandate",
"id": "mdt_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 4
}
}
}
```
## Realtime
A realtime payment was created. The fee is assessed when the payment is submitted, so it's always null on `realtime.created`. Read it from `realtime.processing`.
```json theme={null}
{
"id": "evt_00000000000000000000000000003101",
"object": "event",
"type": "realtime.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "rt_00000000000000000000000000000001",
"resourceType": "realtime",
"createdAt": "2026-09-03T12:00:00Z",
"data": {
"object": {
"type": "realtime",
"id": "rt_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": null,
"status": "CREATED",
"description": "Invoice 1042 settlement",
"internalDescription": "Q3 vendor true-up",
"failure": null,
"submittedAt": null,
"settledAt": null,
"terminalAt": null,
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:00.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 1
}
}
}
```
A realtime payment was accepted by money movement and is processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000003102",
"object": "event",
"type": "realtime.processing",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "rt_00000000000000000000000000000001",
"resourceType": "realtime",
"createdAt": "2026-09-03T12:00:05Z",
"data": {
"object": {
"type": "realtime",
"id": "rt_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": {
"amount": 50,
"currency": "USD",
"payer": "sender",
"applied": "on_top"
},
"status": "PROCESSING",
"description": "Invoice 1042 settlement",
"internalDescription": null,
"failure": null,
"submittedAt": "2026-09-03T12:00:05.000Z",
"settledAt": null,
"terminalAt": null,
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:05.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 2
}
}
}
```
A realtime payment settled. Settled realtime transfers are irrevocable; there is no return state.
```json theme={null}
{
"id": "evt_00000000000000000000000000003103",
"object": "event",
"type": "realtime.settled",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "rt_00000000000000000000000000000001",
"resourceType": "realtime",
"createdAt": "2026-09-03T12:00:09Z",
"data": {
"object": {
"type": "realtime",
"id": "rt_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": {
"amount": 50,
"currency": "USD",
"payer": "sender",
"applied": "on_top"
},
"status": "SETTLED",
"description": "Invoice 1042 settlement",
"internalDescription": null,
"failure": null,
"submittedAt": "2026-09-03T12:00:05.000Z",
"settledAt": "2026-09-03T12:00:09.000Z",
"terminalAt": "2026-09-03T12:00:09.000Z",
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:09.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 3
}
}
}
```
A realtime payment was rejected and failed terminally.
```json theme={null}
{
"id": "evt_00000000000000000000000000003104",
"object": "event",
"type": "realtime.failed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "rt_00000000000000000000000000000001",
"resourceType": "realtime",
"createdAt": "2026-09-03T12:00:08Z",
"data": {
"object": {
"type": "realtime",
"id": "rt_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": null,
"status": "FAILED",
"description": "Invoice 1042 settlement",
"internalDescription": null,
"failure": {
"reason": "Receiving bank rejected the transfer",
"code": "RTP_REJECTED"
},
"submittedAt": "2026-09-03T12:00:05.000Z",
"settledAt": null,
"terminalAt": "2026-09-03T12:00:08.000Z",
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:08.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 3
}
}
}
```
## Wire
A domestic wire was created. The fee is assessed when the wire is submitted, so it's always null on `wire.created`. Read it from `wire.processing`.
```json theme={null}
{
"id": "evt_00000000000000000000000000003101",
"object": "event",
"type": "wire.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "wire_00000000000000000000000000000001",
"resourceType": "wire",
"createdAt": "2026-09-03T12:00:00Z",
"data": {
"object": {
"type": "wire",
"id": "wire_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": null,
"status": "CREATED",
"description": "Invoice 1042 settlement",
"remittanceInfo": "Invoice 1042",
"internalDescription": "Q3 vendor true-up",
"failure": null,
"submittedAt": null,
"rejectedAt": null,
"expectedCompletionAt": null,
"completedAt": null,
"terminalAt": null,
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:00.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 1
}
}
}
```
A domestic wire was submitted for processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000003102",
"object": "event",
"type": "wire.processing",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "wire_00000000000000000000000000000001",
"resourceType": "wire",
"createdAt": "2026-09-03T12:00:05Z",
"data": {
"object": {
"type": "wire",
"id": "wire_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": {
"amount": 1500,
"currency": "USD",
"payer": "sender",
"applied": "on_top"
},
"status": "PROCESSING",
"description": "Invoice 1042 settlement",
"remittanceInfo": "Invoice 1042",
"internalDescription": null,
"failure": null,
"submittedAt": "2026-09-03T12:00:05.000Z",
"rejectedAt": null,
"expectedCompletionAt": null,
"completedAt": null,
"terminalAt": null,
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:05.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 2
}
}
}
```
A domestic wire settled.
```json theme={null}
{
"id": "evt_00000000000000000000000000003103",
"object": "event",
"type": "wire.completed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "wire_00000000000000000000000000000001",
"resourceType": "wire",
"createdAt": "2026-09-03T12:00:09Z",
"data": {
"object": {
"type": "wire",
"id": "wire_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": {
"amount": 1500,
"currency": "USD",
"payer": "sender",
"applied": "on_top"
},
"status": "COMPLETED",
"description": "Invoice 1042 settlement",
"remittanceInfo": "Invoice 1042",
"internalDescription": null,
"failure": null,
"submittedAt": "2026-09-03T12:00:05.000Z",
"rejectedAt": null,
"expectedCompletionAt": null,
"completedAt": "2026-09-03T12:00:09.000Z",
"terminalAt": "2026-09-03T12:00:09.000Z",
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:09.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 3
}
}
}
```
The bank rejected a domestic wire before settlement.
```json theme={null}
{
"id": "evt_00000000000000000000000000003104",
"object": "event",
"type": "wire.rejected",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "wire_00000000000000000000000000000001",
"resourceType": "wire",
"createdAt": "2026-09-03T12:00:08Z",
"data": {
"object": {
"type": "wire",
"id": "wire_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": {
"amount": 1500,
"currency": "USD",
"payer": "sender",
"applied": "on_top"
},
"status": "REJECTED",
"description": "Invoice 1042 settlement",
"remittanceInfo": "Invoice 1042",
"internalDescription": null,
"failure": {
"reason": "Receiving bank rejected the wire",
"code": "WIRE_REJECTED"
},
"submittedAt": "2026-09-03T12:00:05.000Z",
"rejectedAt": "2026-09-03T12:00:08.000Z",
"expectedCompletionAt": null,
"completedAt": null,
"terminalAt": "2026-09-03T12:00:08.000Z",
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:08.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 3
}
}
}
```
A domestic wire failed before completion.
```json theme={null}
{
"id": "evt_00000000000000000000000000003104",
"object": "event",
"type": "wire.failed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "wire_00000000000000000000000000000001",
"resourceType": "wire",
"createdAt": "2026-09-03T12:00:08Z",
"data": {
"object": {
"type": "wire",
"id": "wire_00000000000000000000000000000001",
"attributes": {
"amount": 25000,
"currency": "USD",
"fee": null,
"status": "FAILED",
"description": "Invoice 1042 settlement",
"remittanceInfo": "Invoice 1042",
"internalDescription": null,
"failure": {
"reason": "Wire processing failed",
"code": "PROCESSING_ERROR"
},
"submittedAt": "2026-09-03T12:00:05.000Z",
"rejectedAt": null,
"expectedCompletionAt": null,
"completedAt": null,
"terminalAt": "2026-09-03T12:00:08.000Z",
"createdAt": "2026-09-03T12:00:00.000Z",
"updatedAt": "2026-09-03T12:00:08.000Z"
},
"relationships": {
"customerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
},
"externalPartyAccount": {
"data": {
"type": "external_party_account",
"id": "epa_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000011"
}
}
},
"version": 3
}
}
}
```
## Checks
A check was created.
```json theme={null}
{
"id": "evt_00000000000000000000000000004101",
"object": "event",
"type": "check.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-03T12:00:00Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "created",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": "Q3 vendor true-up",
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": null,
"voidDate": null,
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": null,
"presentmentReturns": [],
"return": null,
"cancellation": null,
"failure": null,
"canonicalReason": null,
"submittedAt": null,
"issuedAt": null,
"stopRequestedAt": null,
"completedAt": null,
"returnedAt": null,
"canceledAt": null,
"expiredAt": null,
"rejectedAt": null,
"terminalAt": null,
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-03T12:00:00Z",
"version": 1
}
}
}
```
A check was submitted for issuance and is processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000004102",
"object": "event",
"type": "check.processing",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-03T12:00:05Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "processing",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": "10042",
"voidDate": "2027-03-02",
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": null,
"presentmentReturns": [],
"return": null,
"cancellation": null,
"failure": null,
"canonicalReason": null,
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": "2026-09-03T12:00:05Z",
"stopRequestedAt": null,
"completedAt": null,
"returnedAt": null,
"canceledAt": null,
"expiredAt": null,
"rejectedAt": null,
"terminalAt": null,
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-03T12:00:05Z",
"version": 2
}
}
}
```
A check was paid and completed.
```json theme={null}
{
"id": "evt_00000000000000000000000000004103",
"object": "event",
"type": "check.completed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-10T15:30:00Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "completed",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": "10042",
"voidDate": "2027-03-02",
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": {
"status": "delivered",
"trackingUrl": null,
"mailedAt": "2026-09-04T18:00:00Z",
"deliveredAt": "2026-09-08T17:00:00Z",
"returnedToSenderAt": null
},
"presentmentReturns": [],
"return": null,
"cancellation": null,
"failure": null,
"canonicalReason": null,
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": "2026-09-03T12:00:05Z",
"stopRequestedAt": null,
"completedAt": "2026-09-10T15:30:00Z",
"returnedAt": null,
"canceledAt": null,
"expiredAt": null,
"rejectedAt": null,
"terminalAt": "2026-09-10T15:30:00Z",
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-10T15:30:00Z",
"version": 3
}
}
}
```
A paid check was returned by the paying bank.
```json theme={null}
{
"id": "evt_00000000000000000000000000004104",
"object": "event",
"type": "check.returned",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-14T09:00:00Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "returned",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": "10042",
"voidDate": "2027-03-02",
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": {
"status": "delivered",
"trackingUrl": null,
"mailedAt": "2026-09-04T18:00:00Z",
"deliveredAt": "2026-09-08T17:00:00Z",
"returnedToSenderAt": null
},
"presentmentReturns": [],
"return": {
"code": "A",
"reason": "Not sufficient funds",
"observedAt": "2026-09-14T09:00:00Z"
},
"cancellation": null,
"failure": null,
"canonicalReason": "CHECK_RETURNED",
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": "2026-09-03T12:00:05Z",
"stopRequestedAt": null,
"completedAt": "2026-09-10T15:30:00Z",
"returnedAt": "2026-09-14T09:00:00Z",
"canceledAt": null,
"expiredAt": null,
"rejectedAt": null,
"terminalAt": "2026-09-14T09:00:00Z",
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-14T09:00:00Z",
"version": 4
}
}
}
```
A check was canceled by a confirmed stop payment or a second-return void.
```json theme={null}
{
"id": "evt_00000000000000000000000000004105",
"object": "event",
"type": "check.canceled",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-05T10:00:00Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "canceled",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": "10042",
"voidDate": "2027-03-02",
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": null,
"presentmentReturns": [],
"return": null,
"cancellation": {
"reason": "Customer requested stop payment",
"returnCode": null,
"requestedAt": "2026-09-04T22:00:00Z",
"confirmedAt": "2026-09-05T10:00:00Z"
},
"failure": null,
"canonicalReason": "CHECK_STOPPED",
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": "2026-09-03T12:00:05Z",
"stopRequestedAt": "2026-09-04T22:00:00Z",
"completedAt": null,
"returnedAt": null,
"canceledAt": "2026-09-05T10:00:00Z",
"expiredAt": null,
"rejectedAt": null,
"terminalAt": "2026-09-05T10:00:00Z",
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-05T10:00:00Z",
"version": 4
}
}
}
```
A check reached its void date without being deposited.
```json theme={null}
{
"id": "evt_00000000000000000000000000004106",
"object": "event",
"type": "check.expired",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2027-03-02T00:00:00Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "expired",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": "10042",
"voidDate": "2027-03-02",
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": {
"status": "delivered",
"trackingUrl": null,
"mailedAt": "2026-09-04T18:00:00Z",
"deliveredAt": "2026-09-08T17:00:00Z",
"returnedToSenderAt": null
},
"presentmentReturns": [],
"return": null,
"cancellation": null,
"failure": null,
"canonicalReason": "CHECK_EXPIRED",
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": "2026-09-03T12:00:05Z",
"stopRequestedAt": null,
"completedAt": null,
"returnedAt": null,
"canceledAt": null,
"expiredAt": "2027-03-02T00:00:00Z",
"rejectedAt": null,
"terminalAt": "2027-03-02T00:00:00Z",
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2027-03-02T00:00:00Z",
"version": 3
}
}
}
```
The provider rejected the check at issuance.
```json theme={null}
{
"id": "evt_00000000000000000000000000004107",
"object": "event",
"type": "check.rejected",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-03T12:00:08Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "rejected",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": null,
"voidDate": null,
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": null,
"presentmentReturns": [],
"return": null,
"cancellation": null,
"failure": {
"code": "CHECK_ISSUANCE_REJECTED",
"reason": "Provider rejected the check issuance"
},
"canonicalReason": "CHECK_ISSUANCE_REJECTED",
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": null,
"stopRequestedAt": null,
"completedAt": null,
"returnedAt": null,
"canceledAt": null,
"expiredAt": null,
"rejectedAt": "2026-09-03T12:00:08Z",
"terminalAt": "2026-09-03T12:00:08Z",
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-03T12:00:08Z",
"version": 3
}
}
}
```
A check failed to issue before it left the platform.
```json theme={null}
{
"id": "evt_00000000000000000000000000004108",
"object": "event",
"type": "check.failed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-03T12:00:07Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "failed",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": null,
"voidDate": null,
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": null,
"presentmentReturns": [],
"return": null,
"cancellation": null,
"failure": {
"code": "CHECK_ISSUANCE_FAILED",
"reason": "Check issuance failed"
},
"canonicalReason": "CHECK_ISSUANCE_FAILED",
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": null,
"stopRequestedAt": null,
"completedAt": null,
"returnedAt": null,
"canceledAt": null,
"expiredAt": null,
"rejectedAt": null,
"terminalAt": "2026-09-03T12:00:07Z",
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-03T12:00:07Z",
"version": 3
}
}
}
```
A mailed check was returned to sender by the carrier; the payment keeps processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000004109",
"object": "event",
"type": "check.returned_to_sender",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "chk_00000000000000000000000000000001",
"resourceType": "check",
"createdAt": "2026-09-09T14:00:00Z",
"data": {
"object": {
"id": "chk_00000000000000000000000000000001",
"type": "check",
"partyId": "pty_00000000000000000000000000000001",
"walletId": "wal_00000000000000000000000000000001",
"externalPartyId": "epty_00000000000000000000000000000001",
"amount": {
"minorUnits": "25000",
"currency": "usd"
},
"status": "processing",
"memo": "Invoice 1042",
"message": "Thank you for your business",
"internalDescription": null,
"deliveryMethod": "USPS_FIRST_CLASS",
"checkNumber": "10042",
"voidDate": "2027-03-02",
"payee": {
"name": "Acme Supply LLC",
"city": "Oakland",
"state": "CA",
"postalCode": "94612",
"addressVersion": 3
},
"delivery": {
"status": "returned_to_sender",
"trackingUrl": null,
"mailedAt": "2026-09-04T18:00:00Z",
"deliveredAt": null,
"returnedToSenderAt": "2026-09-09T14:00:00Z"
},
"presentmentReturns": [],
"return": null,
"cancellation": null,
"failure": null,
"canonicalReason": null,
"submittedAt": "2026-09-03T12:00:05Z",
"issuedAt": "2026-09-03T12:00:05Z",
"stopRequestedAt": null,
"completedAt": null,
"returnedAt": null,
"canceledAt": null,
"expiredAt": null,
"rejectedAt": null,
"terminalAt": null,
"createdAt": "2026-09-03T12:00:00Z",
"updatedAt": "2026-09-09T14:00:00Z",
"version": 5
}
}
}
```
## Mandates
A payer authorized a card mandate.
```json theme={null}
{
"id": "evt_00000000000000000000000000003104",
"object": "event",
"type": "mandate.created",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "mdt_00000000000000000000000000000002",
"resourceType": "mandate",
"createdAt": "2026-09-13T12:00:05Z",
"data": {
"object": {
"id": "mdt_00000000000000000000000000000002",
"type": "mandate",
"merchantId": "pty_00000000000000000000000000000011",
"externalPartyAccountId": null,
"originatorPartyId": "pty_00000000000000000000000000000011",
"scheme": "card",
"amountType": "variable",
"amount": {
"minorUnits": "5000",
"currency": "usd"
},
"currency": "usd",
"frequency": "unscheduled",
"effectiveAt": "2026-09-13T12:00:05Z",
"expiresAt": null,
"status": "active",
"revokedAt": null,
"revocationReason": null,
"supersedesMandateId": null,
"supersededByMandateId": null,
"consumedAt": null,
"terminatedAt": null,
"retainUntil": null,
"card": {
"description": "Usage-based fees are billed.",
"disclosureText": "I authorize Acme to charge my Visa ending in 4242 for usage-based fees.",
"brand": "visa",
"last4": "4242",
"expiryMonth": 12,
"expiryYear": 2030,
"removed": false,
"establishingCardPaymentId": "cpy_00000000000000000000000000000031"
},
"createdAt": "2026-09-13T12:00:05Z",
"updatedAt": "2026-09-13T12:00:05Z",
"version": 1
}
}
}
```
A mandate expired, was superseded, or was consumed.
```json theme={null}
{
"id": "evt_00000000000000000000000000003103",
"object": "event",
"type": "mandate.updated",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "mdt_00000000000000000000000000000002",
"resourceType": "mandate",
"createdAt": "2026-09-14T09:00:00Z",
"data": {
"object": {
"id": "mdt_00000000000000000000000000000002",
"type": "mandate",
"merchantId": "pty_00000000000000000000000000000011",
"externalPartyAccountId": null,
"originatorPartyId": "pty_00000000000000000000000000000011",
"scheme": "card",
"amountType": "variable",
"amount": {
"minorUnits": "5000",
"currency": "usd"
},
"currency": "usd",
"frequency": "unscheduled",
"effectiveAt": "2026-09-13T12:00:05Z",
"expiresAt": "2026-09-14T09:00:00Z",
"status": "expired",
"revokedAt": null,
"revocationReason": null,
"supersedesMandateId": null,
"supersededByMandateId": null,
"consumedAt": null,
"terminatedAt": null,
"retainUntil": null,
"card": {
"description": "Usage-based fees are billed.",
"disclosureText": "I authorize Acme to charge my Visa ending in 4242 for usage-based fees.",
"brand": "visa",
"last4": "4242",
"expiryMonth": 12,
"expiryYear": 2030,
"removed": false,
"establishingCardPaymentId": "cpy_00000000000000000000000000000031"
},
"createdAt": "2026-09-13T12:00:05Z",
"updatedAt": "2026-09-14T09:00:00Z",
"version": 2
}
}
}
```
A mandate was revoked.
```json theme={null}
{
"id": "evt_00000000000000000000000000003105",
"object": "event",
"type": "mandate.revoked",
"sourcePartyId": "pty_00000000000000000000000000000011",
"resourceId": "mdt_00000000000000000000000000000002",
"resourceType": "mandate",
"createdAt": "2026-09-14T09:00:00Z",
"data": {
"object": {
"id": "mdt_00000000000000000000000000000002",
"type": "mandate",
"merchantId": "pty_00000000000000000000000000000011",
"externalPartyAccountId": null,
"originatorPartyId": "pty_00000000000000000000000000000011",
"scheme": "card",
"amountType": "variable",
"amount": {
"minorUnits": "5000",
"currency": "usd"
},
"currency": "usd",
"frequency": "unscheduled",
"effectiveAt": "2026-09-13T12:00:05Z",
"expiresAt": null,
"status": "revoked",
"revokedAt": "2026-09-14T09:00:00Z",
"revocationReason": "Merchant canceled the agreement.",
"supersedesMandateId": null,
"supersededByMandateId": null,
"consumedAt": null,
"terminatedAt": null,
"retainUntil": null,
"card": {
"description": "Usage-based fees are billed.",
"disclosureText": "I authorize Acme to charge my Visa ending in 4242 for usage-based fees.",
"brand": "visa",
"last4": "4242",
"expiryMonth": 12,
"expiryYear": 2030,
"removed": false,
"establishingCardPaymentId": "cpy_00000000000000000000000000000031"
},
"createdAt": "2026-09-13T12:00:05Z",
"updatedAt": "2026-09-14T09:00:00Z",
"version": 2
}
}
}
```
## Deposits
The public deposit transfer resource became visible. API-initiated deposits usually emit with status "created" before money movement submission; deposits discovered from money movement may emit with the current status, such as "processing". Deposits carry no fee, so `fee` is always null on `deposit.*` events.
```json theme={null}
{
"id": "evt_00000000000000000000000000001001",
"object": "event",
"type": "deposit.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000000001",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:00:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000000001",
"attributes": {
"type": "deposit",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "CREATED",
"method": "standard",
"rail": "ach",
"description": "Deposit",
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": null,
"expectedAvailableAt": null,
"failure": null,
"return": null,
"submittedAt": null,
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:00:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000000001"
}
},
"transaction": {
"data": null
}
},
"version": 1
}
}
}
```
A deposit reached the public completed state.
```json theme={null}
{
"id": "evt_00000000000000000000000000001002",
"object": "event",
"type": "deposit.completed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000000001",
"resourceType": "transfer",
"createdAt": "2026-06-14T09:30:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000000001",
"attributes": {
"type": "deposit",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "COMPLETED",
"method": "standard",
"rail": "ach",
"description": "Deposit",
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": "1234",
"expectedAvailableAt": "2026-06-14T09:30:00.000Z",
"failure": null,
"return": null,
"submittedAt": "2026-06-13T12:01:00.000Z",
"settledAt": "2026-06-14T09:30:00.000Z",
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-14T09:30:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000000001"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "txn_00000000000000000000000000000001"
}
}
},
"version": 4
}
}
}
```
A deposit failed during submit or money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000001003",
"object": "event",
"type": "deposit.failed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000000002",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:05:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000000002",
"attributes": {
"type": "deposit",
"amount": 5000,
"currency": "usd",
"fee": null,
"status": "FAILED",
"method": "standard",
"rail": "ach",
"description": null,
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": "6789",
"expectedAvailableAt": null,
"failure": {
"code": "INSUFFICIENT_FUNDS",
"reason": "insufficient_funds"
},
"return": null,
"submittedAt": "2026-06-13T12:01:00.000Z",
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:05:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000000002"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "txn_00000000000000000000000000000002"
}
}
},
"version": 3
}
}
}
```
An incoming deposit was returned by the bank.
```json theme={null}
{
"id": "evt_00000000000000000000000000001004",
"object": "event",
"type": "deposit.returned",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000000003",
"resourceType": "transfer",
"createdAt": "2026-06-15T16:20:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000000003",
"attributes": {
"type": "deposit",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "RETURNED",
"method": "standard",
"rail": "ach",
"description": "Deposit",
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": "1234",
"expectedAvailableAt": "2026-06-14T09:30:00.000Z",
"failure": null,
"return": {
"code": "R01",
"reason": "Insufficient Funds",
"returnedAt": "2026-06-15T16:20:00.000Z"
},
"submittedAt": "2026-06-13T12:01:00.000Z",
"settledAt": "2026-06-14T09:30:00.000Z",
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-15T16:20:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000000003"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "txn_00000000000000000000000000000003"
}
}
},
"version": 6
}
}
}
```
A deposit was canceled before money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000001005",
"object": "event",
"type": "deposit.canceled",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000000004",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:03:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000000004",
"attributes": {
"type": "deposit",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "CANCELED",
"method": "standard",
"rail": "ach",
"description": null,
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": null,
"expectedAvailableAt": null,
"failure": {
"code": null,
"reason": "policy_canceled"
},
"return": null,
"submittedAt": null,
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:03:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000000004"
}
},
"transaction": {
"data": null
}
},
"version": 2
}
}
}
```
A deposit approval was explicitly denied before money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000001006",
"object": "event",
"type": "deposit.approval_denied",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000000005",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:04:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000000005",
"attributes": {
"type": "deposit",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "APPROVAL_DENIED",
"method": "standard",
"rail": "ach",
"description": null,
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": null,
"expectedAvailableAt": null,
"failure": {
"code": null,
"reason": "risk_policy_denied"
},
"return": null,
"submittedAt": null,
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:04:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000000005"
}
},
"transaction": {
"data": null
}
},
"version": 2
}
}
}
```
## Withdrawals
A withdrawal was created and funds are being moved out of a wallet. Instant withdrawals carry a fee, assessed when the withdrawal is submitted, so it's always null on `withdrawal.created`. Read it from `withdrawal.completed`.
```json theme={null}
{
"id": "evt_00000000000000000000000000002001",
"object": "event",
"type": "withdrawal.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000001001",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:00:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000001001",
"attributes": {
"type": "withdrawal",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "CREATED",
"method": "standard",
"rail": "ach",
"description": "Withdrawal",
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": null,
"expectedAvailableAt": null,
"failure": null,
"return": null,
"submittedAt": null,
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:00:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000001001"
}
},
"transaction": {
"data": null
}
},
"version": 1
}
}
}
```
A withdrawal completed successfully.
```json theme={null}
{
"id": "evt_00000000000000000000000000002002",
"object": "event",
"type": "withdrawal.completed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000001001",
"resourceType": "transfer",
"createdAt": "2026-06-14T09:30:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000001001",
"attributes": {
"type": "withdrawal",
"amount": 2500,
"currency": "usd",
"fee": {
"amount": 38,
"currency": "USD",
"payer": "sender",
"applied": "on_top"
},
"status": "COMPLETED",
"method": "standard",
"rail": "ach",
"description": "Withdrawal",
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": "1234",
"expectedAvailableAt": null,
"failure": null,
"return": null,
"submittedAt": "2026-06-13T12:01:00.000Z",
"settledAt": "2026-06-14T09:30:00.000Z",
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-14T09:30:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000001001"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "txn_00000000000000000000000000001001"
}
}
},
"version": 4
}
}
}
```
A withdrawal failed before settling.
```json theme={null}
{
"id": "evt_00000000000000000000000000002003",
"object": "event",
"type": "withdrawal.failed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000001002",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:05:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000001002",
"attributes": {
"type": "withdrawal",
"amount": 5000,
"currency": "usd",
"fee": null,
"status": "FAILED",
"method": "standard",
"rail": "ach",
"description": null,
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": "6789",
"expectedAvailableAt": null,
"failure": {
"code": "INSUFFICIENT_FUNDS",
"reason": "insufficient_funds"
},
"return": null,
"submittedAt": "2026-06-13T12:01:00.000Z",
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:05:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000001002"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "txn_00000000000000000000000000001002"
}
}
},
"version": 3
}
}
}
```
A settled withdrawal was returned or reversed.
```json theme={null}
{
"id": "evt_00000000000000000000000000002004",
"object": "event",
"type": "withdrawal.returned",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000001003",
"resourceType": "transfer",
"createdAt": "2026-06-15T16:20:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000001003",
"attributes": {
"type": "withdrawal",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "RETURNED",
"method": "standard",
"rail": "ach",
"description": "Withdrawal",
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": "1234",
"expectedAvailableAt": null,
"failure": null,
"return": {
"code": "R03",
"reason": "No account/unable to locate account",
"returnedAt": "2026-06-15T16:20:00.000Z"
},
"submittedAt": "2026-06-13T12:01:00.000Z",
"settledAt": "2026-06-14T09:30:00.000Z",
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-15T16:20:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000001003"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "txn_00000000000000000000000000001003"
}
}
},
"version": 6
}
}
}
```
A withdrawal was canceled before money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000002005",
"object": "event",
"type": "withdrawal.canceled",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000001004",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:03:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000001004",
"attributes": {
"type": "withdrawal",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "CANCELED",
"method": "standard",
"rail": "ach",
"description": null,
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": null,
"expectedAvailableAt": null,
"failure": {
"code": null,
"reason": "policy_canceled"
},
"return": null,
"submittedAt": null,
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:03:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000001004"
}
},
"transaction": {
"data": null
}
},
"version": 2
}
}
}
```
A withdrawal approval was explicitly denied before money movement processing.
```json theme={null}
{
"id": "evt_00000000000000000000000000002006",
"object": "event",
"type": "withdrawal.approval_denied",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "trf_00000000000000000000000000001005",
"resourceType": "transfer",
"createdAt": "2026-06-13T12:04:00Z",
"data": {
"object": {
"type": "transfer",
"id": "trf_00000000000000000000000000001005",
"attributes": {
"type": "withdrawal",
"amount": 2500,
"currency": "usd",
"fee": null,
"status": "APPROVAL_DENIED",
"method": "standard",
"rail": "ach",
"description": null,
"tags": {
"workflow": "treasury"
},
"externalAccountDisplayMask": null,
"expectedAvailableAt": null,
"failure": {
"code": null,
"reason": "risk_policy_denied"
},
"return": null,
"submittedAt": null,
"settledAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:04:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": {
"type": "agent",
"id": "agt_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"externalAccount": {
"data": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000001005"
}
},
"transaction": {
"data": null
}
},
"version": 2
}
}
}
```
## Payment requests
A merchant created a payment request. The fee is assessed when the request is paid, so it's null until `payment_request.completed`. `payment_request.incoming`, sent to the payer, never carries it.
```json theme={null}
{
"id": "evt_00000000000000000000000000003001",
"object": "event",
"type": "payment_request.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "prq_00000000000000000000000000000001",
"resourceType": "payment_request",
"createdAt": "2026-06-13T12:00:00Z",
"data": {
"object": {
"type": "paymentRequest",
"id": "prq_00000000000000000000000000000001",
"attributes": {
"amount": 2500,
"currency": "USD",
"fee": null,
"status": "OPEN",
"payerCanPay": true,
"payerCanDecline": true,
"description": "Invoice 7",
"tags": {
"workflow": "collections"
},
"requesterName": "Natural Merchant",
"requesterEmail": "merchant@example.com",
"requesterAvatarUrl": null,
"requesterHandle": null,
"walletName": null,
"payerName": null,
"payerEmail": "payer@example.com",
"payerAvatarUrl": null,
"payerHandle": null,
"payerPhone": null,
"payerPartyId": null,
"payerIdentifierType": "email",
"payerIdentifier": "payer@example.com",
"initiatorParty": null,
"paymentLinkUrl": "https://app.natural.com/pay/yzAj1dmnRg6UR3GqQ-715g-HQYt2ML_YsJwQkKSS6FA",
"transactionId": null,
"expiresAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:00:00.000Z"
},
"relationships": {
"requesterParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"payerParty": {
"data": null
},
"payerAgent": {
"data": null
},
"payment": {
"data": null
},
"initiatorAgent": {
"data": null
}
},
"version": 1
}
}
}
```
The linked payment for a payment request completed successfully.
```json theme={null}
{
"id": "evt_00000000000000000000000000003002",
"object": "event",
"type": "payment_request.completed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "prq_00000000000000000000000000000001",
"resourceType": "payment_request",
"createdAt": "2026-06-13T12:15:00Z",
"data": {
"object": {
"type": "paymentRequest",
"id": "prq_00000000000000000000000000000001",
"attributes": {
"amount": 2500,
"currency": "USD",
"fee": {
"amount": 3,
"currency": "USD",
"payer": "recipient",
"applied": "deducted"
},
"status": "COMPLETED",
"payerCanPay": false,
"payerCanDecline": false,
"description": "Invoice 7",
"tags": {
"workflow": "collections"
},
"requesterName": "Natural Merchant",
"requesterEmail": "merchant@example.com",
"requesterAvatarUrl": null,
"requesterHandle": null,
"walletName": null,
"payerName": null,
"payerEmail": "payer@example.com",
"payerAvatarUrl": null,
"payerHandle": null,
"payerPhone": null,
"payerPartyId": "pty_00000000000000000000000000000002",
"payerIdentifierType": "party_id",
"payerIdentifier": "pty_00000000000000000000000000000002",
"initiatorParty": null,
"paymentLinkUrl": "https://app.natural.com/pay/yzAj1dmnRg6UR3GqQ-715g-HQYt2ML_YsJwQkKSS6FA",
"transactionId": null,
"expiresAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:15:00.000Z"
},
"relationships": {
"requesterParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"payerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"payerAgent": {
"data": null
},
"payment": {
"data": {
"type": "payment",
"id": "pay_00000000000000000000000000000001"
}
},
"initiatorAgent": {
"data": null
}
},
"version": 7
}
}
}
```
A merchant canceled an open payment request.
```json theme={null}
{
"id": "evt_00000000000000000000000000003003",
"object": "event",
"type": "payment_request.canceled",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "prq_00000000000000000000000000000001",
"resourceType": "payment_request",
"createdAt": "2026-06-13T12:20:00Z",
"data": {
"object": {
"type": "paymentRequest",
"id": "prq_00000000000000000000000000000001",
"attributes": {
"amount": 2500,
"currency": "USD",
"fee": null,
"status": "CANCELED",
"payerCanPay": false,
"payerCanDecline": false,
"description": "Invoice 7",
"tags": {
"workflow": "collections"
},
"requesterName": "Natural Merchant",
"requesterEmail": "merchant@example.com",
"requesterAvatarUrl": null,
"requesterHandle": null,
"walletName": null,
"payerName": null,
"payerEmail": "payer@example.com",
"payerAvatarUrl": null,
"payerHandle": null,
"payerPhone": null,
"payerPartyId": "pty_00000000000000000000000000000002",
"payerIdentifierType": "party_id",
"payerIdentifier": "pty_00000000000000000000000000000002",
"initiatorParty": null,
"paymentLinkUrl": "https://app.natural.com/pay/yzAj1dmnRg6UR3GqQ-715g-HQYt2ML_YsJwQkKSS6FA",
"transactionId": null,
"expiresAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:20:00.000Z"
},
"relationships": {
"requesterParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"payerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"payerAgent": {
"data": null
},
"payment": {
"data": null
},
"initiatorAgent": {
"data": null
}
},
"version": 3
}
}
}
```
The payer declined an open payment request.
```json theme={null}
{
"id": "evt_00000000000000000000000000003004",
"object": "event",
"type": "payment_request.declined",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "prq_00000000000000000000000000000001",
"resourceType": "payment_request",
"createdAt": "2026-06-13T12:25:00Z",
"data": {
"object": {
"type": "paymentRequest",
"id": "prq_00000000000000000000000000000001",
"attributes": {
"amount": 2500,
"currency": "USD",
"fee": null,
"status": "DECLINED",
"payerCanPay": false,
"payerCanDecline": false,
"description": "Invoice 7",
"tags": {
"workflow": "collections"
},
"requesterName": "Natural Merchant",
"requesterEmail": "merchant@example.com",
"requesterAvatarUrl": null,
"requesterHandle": null,
"walletName": null,
"payerName": null,
"payerEmail": "payer@example.com",
"payerAvatarUrl": null,
"payerHandle": null,
"payerPhone": null,
"payerPartyId": "pty_00000000000000000000000000000002",
"payerIdentifierType": "party_id",
"payerIdentifier": "pty_00000000000000000000000000000002",
"initiatorParty": null,
"paymentLinkUrl": "https://app.natural.com/pay/yzAj1dmnRg6UR3GqQ-715g-HQYt2ML_YsJwQkKSS6FA",
"transactionId": null,
"expiresAt": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:25:00.000Z"
},
"relationships": {
"requesterParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"payerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"payerAgent": {
"data": null
},
"payment": {
"data": null
},
"initiatorAgent": {
"data": null
}
},
"version": 4
}
}
}
```
A payment request was created naming this party as the payer.
```json theme={null}
{
"id": "evt_0000000000000000000000000000000e",
"object": "event",
"type": "payment_request.incoming",
"sourcePartyId": "pty_00000000000000000000000000000002",
"resourceId": "prq_00000000000000000000000000000001",
"resourceType": "payment_request",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"type": "paymentRequest",
"id": "prq_00000000000000000000000000000001",
"attributes": {
"amount": 500,
"currency": "USD",
"fee": null,
"status": "OPEN",
"payerCanPay": true,
"payerCanDecline": true,
"description": "Invoice 7",
"tags": {
"workflow": "collections"
},
"requesterName": "Natural Merchant",
"requesterEmail": "merchant@example.com",
"requesterAvatarUrl": null,
"requesterHandle": null,
"walletName": null,
"payerName": null,
"payerEmail": "payer@example.com",
"payerAvatarUrl": null,
"payerHandle": null,
"payerPhone": null,
"payerPartyId": "pty_00000000000000000000000000000002",
"payerIdentifierType": "party_id",
"payerIdentifier": "pty_00000000000000000000000000000002",
"initiatorParty": null,
"paymentLinkUrl": "https://app.natural.com/pay/yzAj1dmnRg6UR3GqQ-715g-HQYt2ML_YsJwQkKSS6FA",
"transactionId": null,
"expiresAt": null,
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z"
},
"relationships": {
"requesterParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
},
"wallet": {
"data": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001"
}
},
"payerParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
},
"payerAgent": {
"data": null
},
"payment": {
"data": null
},
"initiatorAgent": {
"data": null
}
},
"version": 1
}
}
}
```
## Approvals
A customer approval is required before the payment can continue.
```json theme={null}
{
"id": "evt_00000000000000000000000000007001",
"object": "event",
"type": "approval.required",
"sourcePartyId": "pty_00000000000000000000000000000003",
"resourceId": "apr_00000000000000000000000000000001",
"resourceType": "approval",
"createdAt": "2026-06-13T12:00:00Z",
"data": {
"object": {
"type": "approval",
"id": "apr_00000000000000000000000000000001",
"attributes": {
"status": "pending",
"target": {
"type": "payment",
"id": "pay_00000000000000000000000000000001"
},
"payment": {
"amount": 15000,
"currency": "USD"
},
"fee": null,
"reasons": [
{
"type": "limitExceeded",
"limitType": "dailyAmount",
"limitAmount": 10000,
"actualAmount": 15000,
"currency": "USD"
}
],
"customer": null,
"ach": null,
"realtime": null,
"wire": null,
"check": null,
"denialReason": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:00:00.000Z",
"resolvedAt": null
},
"version": 1,
"relationships": {
"initiatorAgent": {
"data": null
}
}
}
}
}
```
A customer approval was approved.
```json theme={null}
{
"id": "evt_00000000000000000000000000007002",
"object": "event",
"type": "approval.approved",
"sourcePartyId": "pty_00000000000000000000000000000003",
"resourceId": "apr_00000000000000000000000000000002",
"resourceType": "approval",
"createdAt": "2026-06-13T12:05:00Z",
"data": {
"object": {
"type": "approval",
"id": "apr_00000000000000000000000000000002",
"attributes": {
"status": "approved",
"target": {
"type": "payment",
"id": "pay_00000000000000000000000000000001"
},
"payment": {
"amount": 15000,
"currency": "USD"
},
"fee": null,
"reasons": [
{
"type": "limitExceeded",
"limitType": "perTransactionAmount",
"limitAmount": 10000,
"actualAmount": 15000,
"currency": "USD"
}
],
"customer": null,
"ach": null,
"realtime": null,
"wire": null,
"check": null,
"denialReason": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:05:00.000Z",
"resolvedAt": "2026-06-13T12:05:00.000Z"
},
"version": 2,
"relationships": {
"initiatorAgent": {
"data": null
}
}
}
}
}
```
A customer approval was denied.
```json theme={null}
{
"id": "evt_00000000000000000000000000007003",
"object": "event",
"type": "approval.denied",
"sourcePartyId": "pty_00000000000000000000000000000003",
"resourceId": "apr_00000000000000000000000000000003",
"resourceType": "approval",
"createdAt": "2026-06-13T12:07:00Z",
"data": {
"object": {
"type": "approval",
"id": "apr_00000000000000000000000000000003",
"attributes": {
"status": "denied",
"target": {
"type": "payment",
"id": "pay_00000000000000000000000000000003"
},
"payment": {
"amount": 15000,
"currency": "USD"
},
"fee": null,
"reasons": [
{
"type": "limitExceeded",
"limitType": "monthlyAmount",
"limitAmount": 100000,
"actualAmount": 125000,
"currency": "USD"
}
],
"customer": null,
"ach": null,
"realtime": null,
"wire": null,
"check": null,
"denialReason": "Over the delegated limit",
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:07:00.000Z",
"resolvedAt": "2026-06-13T12:07:00.000Z"
},
"version": 2,
"relationships": {
"initiatorAgent": {
"data": null
}
}
}
}
}
```
A customer approval was canceled before completion.
```json theme={null}
{
"id": "evt_00000000000000000000000000007004",
"object": "event",
"type": "approval.canceled",
"sourcePartyId": "pty_00000000000000000000000000000003",
"resourceId": "apr_00000000000000000000000000000004",
"resourceType": "approval",
"createdAt": "2026-06-13T12:08:00Z",
"data": {
"object": {
"type": "approval",
"id": "apr_00000000000000000000000000000004",
"attributes": {
"status": "canceled",
"target": {
"type": "payment",
"id": "pay_00000000000000000000000000000004"
},
"payment": {
"amount": 15000,
"currency": "USD"
},
"fee": null,
"reasons": [],
"customer": null,
"ach": null,
"realtime": null,
"wire": null,
"check": null,
"denialReason": null,
"createdAt": "2026-06-13T12:00:00.000Z",
"updatedAt": "2026-06-13T12:08:00.000Z",
"resolvedAt": "2026-06-13T12:05:00.000Z"
},
"version": 3,
"relationships": {
"initiatorAgent": {
"data": null
}
}
}
}
}
```
## Parties
A party's information was updated.
```json theme={null}
{
"id": "evt_00000000000000000000000000000001",
"object": "event",
"type": "party.updated",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "pty_00000000000000000000000000000001",
"resourceType": "party",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"id": "pty_00000000000000000000000000000001",
"type": "party",
"attributes": {
"partyType": "ORG",
"legalName": "Acme Corp",
"firstName": null,
"lastName": null,
"displayName": "Acme",
"handle": null,
"avatarUrl": null,
"status": "ACTIVE",
"persona": null,
"email": "admin@acme.example.com",
"primaryPhone": null,
"addressLine1": null,
"addressCity": null,
"addressState": null,
"addressPostalCode": null,
"addressCountry": null,
"createdBy": null,
"createdAt": "2026-01-10T10:00:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z"
},
"version": 3
}
}
}
```
## Compliance
A party's canonical compliance case reached a public verification outcome.
```json theme={null}
{
"id": "evt_00000000000000000000000000000040",
"object": "event",
"type": "compliance_case.updated",
"sourcePartyId": "pty_7c9e6679e29b41d4a716446655440001",
"resourceId": "cpc_00000000000000000000000000000001",
"resourceType": "compliance_case",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"id": "cpc_00000000000000000000000000000001",
"type": "compliance_case",
"attributes": {
"partyId": "pty_00000000000000000000000000000001",
"status": "approved"
},
"version": 7
}
}
}
```
## Wallets
A wallet was created for a party.
```json theme={null}
{
"id": "evt_00000000000000000000000000000003",
"object": "event",
"type": "wallet.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "wal_00000000000000000000000000000001",
"resourceType": "wallet",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"type": "wallet",
"id": "wal_00000000000000000000000000000001",
"attributes": {
"status": "active",
"walletType": "standard",
"isDefault": false,
"createdAt": "2026-01-10T10:00:00.000Z",
"displayName": "Wallet",
"description": null,
"tags": {
"environment": "production"
},
"balance": null,
"claims": {
"amount": 0,
"count": 0
},
"depositInstructions": null
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
}
},
"version": 1
}
}
}
```
## Delegations
A developer created a per-agent invitation for a customer to accept.
```json theme={null}
{
"id": "evt_0000000000000000000000000000000a",
"object": "event",
"type": "agent_delegation_invitation.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "adi_00000000000000000000000000000001",
"resourceType": "agent_delegation_invitation",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"invitationId": "adi_00000000000000000000000000000001",
"agentId": "agt_00000000000000000000000000000001",
"delegateePartyId": "pty_00000000000000000000000000000002",
"delegatorPartyId": null,
"customerEmail": "customer@example.com",
"status": "pending",
"permissions": [
"payments.create"
],
"limits": {
"perTransactionCents": 50000,
"perDayCents": 200000,
"perMonthCents": 1000000
},
"expiresAt": "2026-02-15T14:30:00Z",
"createdAt": "2026-01-10T10:00:00Z",
"updatedAt": "2026-01-15T14:30:00Z",
"version": 1,
"tags": {
"campaign": "q3_reactivation",
"crm_id": "hub_84921"
}
}
}
}
```
A customer accepted a per-agent invitation; the per-agent grant is now active.
```json theme={null}
{
"id": "evt_019cd3444a7a70efaf554fd8450d2302",
"object": "event",
"type": "agent_delegation_invitation.accepted",
"sourcePartyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
"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,
"tags": {
"campaign": "q3_reactivation",
"crm_id": "hub_84921"
}
}
}
}
```
A customer declined a per-agent invitation.
```json theme={null}
{
"id": "evt_019cd3444a7a70efaf554fd8450d2303",
"object": "event",
"type": "agent_delegation_invitation.declined",
"sourcePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
"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,
"tags": {
"campaign": "q3_reactivation",
"crm_id": "hub_84921"
}
}
}
}
```
A pending per-agent invitation was canceled.
```json theme={null}
{
"id": "evt_019cd3444a7a70efaf554fd8450d2304",
"object": "event",
"type": "agent_delegation_invitation.canceled",
"sourcePartyId": "pty_019cd34e27bf78399b4e75b327d2cd36",
"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": "canceled",
"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,
"tags": {
"campaign": "q3_reactivation",
"crm_id": "hub_84921"
}
}
}
}
```
A per-agent grant was revoked.
```json theme={null}
{
"id": "evt_00000000000000000000000000000008",
"object": "event",
"type": "agent_delegation.revoked",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "adl_00000000000000000000000000000001",
"resourceType": "agent_delegation",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"agentDelegationId": "adl_00000000000000000000000000000001",
"delegationId": "dlg_00000000000000000000000000000001",
"agentId": "agt_00000000000000000000000000000001",
"permissions": [
"wallets.read",
"payments.create"
],
"status": "revoked",
"revokeReason": "customer",
"sourceType": "invitation",
"sourceInvitationId": "adi_00000000000000000000000000000001",
"expiresAt": "2026-02-15T14:30:00Z",
"createdAt": "2026-01-10T10:00:00Z",
"updatedAt": "2026-01-15T14:30:00Z",
"version": 5
}
}
}
```
A parent delegation row went active.
```json theme={null}
{
"id": "evt_00000000000000000000000000000006",
"object": "event",
"type": "delegation.activated",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "dlg_00000000000000000000000000000001",
"resourceType": "delegation",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"delegatorPartyId": "pty_00000000000000000000000000000001",
"delegateePartyId": "pty_00000000000000000000000000000002",
"permissions": [
"wallets.read"
],
"status": "active",
"sourceType": "link",
"sourceId": "ivl_00000000000000000000000000000001",
"createdAt": "2026-01-10T10:00:00Z",
"version": 2
}
}
}
```
The customer connection was ended. Fires when either party explicitly disconnects; revoking individual agents, even the last one, does not revoke the parent delegation.
```json theme={null}
{
"id": "evt_019cd3444a7a70efaf554fd8450d2307",
"object": "event",
"type": "delegation.revoked",
"sourcePartyId": "pty_019cd34e27bf78399b4e75b327d2ab25",
"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",
"sourceId": "adi_019cd3444a7a70efaf554fd8450d6812",
"createdAt": "2026-01-15T15:00:00Z",
"version": 2
}
}
}
```
## Invitation links
A reusable invitation link was created with its initial offered agents.
```json theme={null}
{
"id": "evt_00000000000000000000000000000051",
"object": "event",
"type": "invitation_link.created",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ivl_00000000000000000000000000000031",
"resourceType": "invitation_link",
"createdAt": "2026-02-01T09:00:00Z",
"data": {
"object": {
"type": "invitationLink",
"id": "ivl_00000000000000000000000000000031",
"attributes": {
"proposedAgents": [
{
"agentId": "agt_00000000000000000000000000000011",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 50000
}
},
{
"agentId": "agt_00000000000000000000000000000012",
"permissions": [
"payments.create"
],
"limits": null
}
],
"status": "ACTIVE",
"createdAt": "2026-02-01T09:00:00.000Z",
"name": "Vendor onboarding link",
"expiresAt": "2026-03-01T00:00:00.000Z",
"tags": {
"campaign": "vendor_onboarding"
},
"maskedToken": "***0f9a"
},
"relationships": {
"delegateeParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
}
},
"version": 1
}
}
}
```
An invitation link was revoked and its open offers were withdrawn.
```json theme={null}
{
"id": "evt_00000000000000000000000000000052",
"object": "event",
"type": "invitation_link.revoked",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ivl_00000000000000000000000000000031",
"resourceType": "invitation_link",
"createdAt": "2026-02-10T16:45:00Z",
"data": {
"object": {
"type": "invitationLink",
"id": "ivl_00000000000000000000000000000031",
"attributes": {
"proposedAgents": [
{
"agentId": "agt_00000000000000000000000000000011",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 50000
}
},
{
"agentId": "agt_00000000000000000000000000000012",
"permissions": [
"payments.read"
],
"limits": null
}
],
"status": "REVOKED",
"createdAt": "2026-02-01T09:00:00.000Z",
"name": "Vendor onboarding link",
"expiresAt": null,
"tags": {
"campaign": "vendor_onboarding"
},
"maskedToken": "***0f9a"
},
"relationships": {
"delegateeParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
}
},
"version": 2
}
}
}
```
An agent offer was added to an invitation link.
```json theme={null}
{
"id": "evt_00000000000000000000000000000053",
"object": "event",
"type": "invitation_link.agent_added",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ivl_00000000000000000000000000000031",
"resourceType": "invitation_link",
"createdAt": "2026-02-03T11:20:00Z",
"data": {
"object": {
"type": "invitationLink",
"id": "ivl_00000000000000000000000000000031",
"attributes": {
"proposedAgents": [
{
"agentId": "agt_00000000000000000000000000000011",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 50000
}
},
{
"agentId": "agt_00000000000000000000000000000012",
"permissions": [
"payments.read"
],
"limits": null
}
],
"status": "ACTIVE",
"createdAt": "2026-02-01T09:00:00.000Z",
"name": "Vendor onboarding link",
"expiresAt": "2026-03-01T00:00:00.000Z",
"tags": {
"campaign": "vendor_onboarding"
},
"maskedToken": "***0f9a"
},
"relationships": {
"delegateeParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
}
},
"version": 1
}
}
}
```
An agent offer was removed from an invitation link.
```json theme={null}
{
"id": "evt_00000000000000000000000000000054",
"object": "event",
"type": "invitation_link.agent_removed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ivl_00000000000000000000000000000031",
"resourceType": "invitation_link",
"createdAt": "2026-02-04T08:05:00Z",
"data": {
"object": {
"type": "invitationLink",
"id": "ivl_00000000000000000000000000000031",
"attributes": {
"proposedAgents": [
{
"agentId": "agt_00000000000000000000000000000012",
"permissions": [
"payments.read"
],
"limits": null
}
],
"status": "ACTIVE",
"createdAt": "2026-02-01T09:00:00.000Z",
"name": "Vendor onboarding link",
"expiresAt": "2026-03-01T00:00:00.000Z",
"tags": {
"campaign": "vendor_onboarding"
},
"maskedToken": "***0f9a"
},
"relationships": {
"delegateeParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
}
},
"version": 1
}
}
}
```
A customer redeemed an invitation link; the resulting access grant is reported by its own events.
```json theme={null}
{
"id": "evt_00000000000000000000000000000055",
"object": "event",
"type": "invitation_link.redeemed",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "ivl_00000000000000000000000000000031",
"resourceType": "invitation_link",
"createdAt": "2026-02-05T19:30:00Z",
"data": {
"object": {
"type": "invitationLink",
"id": "ivl_00000000000000000000000000000031",
"attributes": {
"proposedAgents": [
{
"agentId": "agt_00000000000000000000000000000011",
"permissions": [
"payments.read",
"payments.create"
],
"limits": {
"perTransaction": 50000
}
},
{
"agentId": "agt_00000000000000000000000000000012",
"permissions": [
"payments.read"
],
"limits": null
}
],
"status": "ACTIVE",
"createdAt": "2026-02-01T09:00:00.000Z",
"name": "Vendor onboarding link",
"expiresAt": "2026-03-01T00:00:00.000Z",
"tags": {
"campaign": "vendor_onboarding"
},
"maskedToken": "***0f9a"
},
"relationships": {
"delegateeParty": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000002"
}
}
},
"version": 1
}
}
}
```
## External party accounts
An external party bank account passed validation.
```json theme={null}
{
"id": "evt_00000000000000000000000000003201",
"object": "event",
"type": "external_party_account.validated",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "epa_00000000000000000000000000000001",
"resourceType": "external_party_account",
"createdAt": "2026-08-11T12:00:00Z",
"data": {
"object": {
"id": "epa_00000000000000000000000000000001",
"type": "external_party_account",
"attributes": {
"accountDetails": {
"type": "us_bank_account",
"accountType": "checking",
"last4": "6789",
"mask": "****6789"
},
"validationState": "validated",
"supportedRails": [
"ach",
"realtime",
"wire"
],
"createdAt": "2026-08-11T12:00:00.000Z",
"updatedAt": "2026-08-11T12:00:00.000Z"
},
"relationships": {
"externalParty": {
"data": {
"type": "external_party",
"id": "epty_00000000000000000000000000000001"
}
}
},
"version": 1
}
}
}
```
## External accounts
An external bank account was linked.
```json theme={null}
{
"id": "evt_00000000000000000000000000000004",
"object": "event",
"type": "external_account.connected",
"sourcePartyId": "pty_00000000000000000000000000000001",
"resourceId": "eac_00000000000000000000000000000001",
"resourceType": "external_account",
"createdAt": "2026-01-15T14:30:00Z",
"data": {
"object": {
"type": "externalAccount",
"id": "eac_00000000000000000000000000000001",
"attributes": {
"bankName": "Test Bank",
"accountName": "Operating",
"accountType": "checking",
"lastFour": "1234",
"status": "active",
"connectionStatus": "active",
"availableMethods": [
"standard"
],
"tags": {
"environment": "production"
},
"createdAt": "2026-01-15T14:30:00.000Z"
},
"relationships": {
"party": {
"data": {
"type": "party",
"id": "pty_00000000000000000000000000000001"
}
}
},
"version": 1
}
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.