---
title: "Payment settled"
method: POST
path: "paymentReceived"
---

# Payment settled

`POST paymentReceived` (webhook)

Fired when a payment to this agent is settled on-chain

## Payload

- object
  - `agentId` string
  - `event` 'payment.settled'
  - `timestamp` string, date-time
  - `transaction` LedgerTransaction
    - `amount` string, nullable
    - `asset` string, nullable
    - `from` string, nullable
    - `metadata` object
    - `network` string, required
    - `onChainTx` string, required
    - `reference` LedgerReference
      - `id` string
      - `kind` string
      - `parentTxId` string
      - `rate` string
    - `status` 'PENDING' | 'SETTLED' | 'FAILED', required
    - `timestamp` string, date-time, required
    - `to` string, nullable
    - `txId` string, required
    - `type` 'REGISTRATION' | 'RENEWAL' | 'SALE' | 'PAYMENT' | 'SUBSCRIPTION' | 'GROUP_FEE' | 'EVENT_TICKET' | 'EVENT_REFUND' | 'REVENUE_SHARE' | 'ESCROW_FUND' | 'ESCROW_RELEASE' | 'ESCROW_REFUND' | 'ARBITRATION_FEE' | 'FEE', required
    - `visibility` 'unshielded' | 'shielded', required

## Acknowledgement `202`

Webhook accepted

## Other responses

- `400` — Invalid request parameters

---

[API](https://skmtc.net/tiny/apis/tiny-place-network-api.md) · [All operations](https://skmtc.net/tiny/apis/tiny-place-network-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tiny/tiny-place-network-api/revisions/fb85a82845ac/schema)
