> ## Documentation Index > Fetch the complete documentation index at: https://nevermined.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Report Settlement > After you attached a mode-A credential and the agent settled on-chain, report the settlement `txHash` (from the agent’s `PAYMENT-RESPONSE` / `X-PAYMENT-RESPONSE` header) so the payment record moves `Issued → Settled`. Idempotent: re-reporting the same txHash is a no-op; a different txHash, or a record not in `Issued`, is rejected. NOT needed for mode B (`/route` and `/proxy` self-complete the record from the upstream settlement header). ## OpenAPI ````yaml POST /router/payments/{id}/settled openapi: 3.1.0 info: title: Nevermined API description: >- API for managing AI agents, payment plans, and x402 payments in the Nevermined ecosystem. ## Prerequisites You need a Nevermined API Key to authenticate. Get one at [nevermined.app](https://nevermined.app) under **Settings > API Keys**. See the [5-Minute Setup Guide](/docs/integrate/quickstart/5-minute-setup) for detailed instructions. license: name: MIT version: 1.0.0 servers: - url: https://api.sandbox.nevermined.app/api/v1 description: Sandbox (Testing) - Base Sepolia - url: https://api.live.nevermined.app/api/v1 description: Live (Production) - Base Mainnet security: - bearerAuth: [] tags: - name: Protocol - Agents description: Endpoints for registering and managing AI agents - name: Protocol - Plans description: Endpoints for creating and managing payment plans - name: Protocol - Credits description: Endpoints for minting and redeeming credits - name: Protocol - Access description: Endpoints for access tokens and request validation - name: X402 - Permissions description: Endpoints for x402 delegated permissions paths: /router/payments/{id}/settled: post: tags: - Router summary: >- Report the on-chain settlement tx for a minted payment (completes the record) description: >- After you attached a mode-A credential and the agent settled on-chain, report the settlement `txHash` (from the agent’s `PAYMENT-RESPONSE` / `X-PAYMENT-RESPONSE` header) so the payment record moves `Issued → Settled`. Idempotent: re-reporting the same txHash is a no-op; a different txHash, or a record not in `Issued`, is rejected. NOT needed for mode B (`/route` and `/proxy` self-complete the record from the upstream settlement header). operationId: reportPaymentSettlement parameters: - name: id required: true in: path description: The `paymentId` returned by `POST /router/payments`. schema: type: string example: b1f9c2e4-3d5a-4c7e-9f21-6a8b0c4d2e13 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SettlePaymentDto' responses: '201': description: The record is now `Settled`. content: application/json: schema: $ref: '#/components/schemas/SettleResponseDto' '401': description: Missing/invalid Nevermined API key. content: application/json: schema: $ref: '#/components/schemas/RouterErrorResponseDto' '404': description: No payment record with that id for this caller (BCK.ROUTER.0004). content: application/json: schema: $ref: '#/components/schemas/RouterErrorResponseDto' '409': description: >- Record not settleable — already settled with a different tx, or not in `Issued` (BCK.ROUTER.0005). content: application/json: schema: $ref: '#/components/schemas/RouterErrorResponseDto' components: schemas: SettlePaymentDto: type: object properties: txHash: type: string description: >- On-chain settlement tx hash (from the upstream's PAYMENT-RESPONSE header). example: '0xfc8af37baae588b5ee4a5e9212532b3d46702ac009b64c17e8ff810fd90ac493' required: - txHash SettleResponseDto: type: object properties: paymentId: type: string example: b1f9c2e4-3d5a-4c7e-9f21-6a8b0c4d2e13 status: type: string enum: - Settled example: Settled txHash: type: string example: '0xfc8af37baae588b5ee4a5e9212532b3d46702ac009b64c17e8ff810fd90ac493' required: - paymentId - status - txHash RouterErrorResponseDto: type: object properties: code: type: string description: >- Router error code. `BCK.ROUTER.0001` invalid request / no fundable option / bad 402 (400); `BCK.ROUTER.0002` requestId already used — idempotency conflict (409); `BCK.ROUTER.0003` delegation budget exceeded, expired, or inactive (402); `BCK.ROUTER.0004` payment record not found (404); `BCK.ROUTER.0005` payment not in a settleable state (409). Framework-level `BCK.HTTP.*` codes (e.g. `BCK.HTTP.400` request validation, `BCK.HTTP.429` throttling) may also appear — see the base `code` field. example: BCK.ROUTER.0003 httpStatus: type: number description: HTTP status code example: 500 message: type: string description: Error message for Router operations. example: delegation budget exceeded, expired, or inactive examples: - >- delegationId is required — create one via POST /api/v1/delegation/create - 'no fundable option; offered: [...]' - >- upstream pay-to address is not in this delegation's allowed recipients - delegation budget exceeded, expired, or inactive - payment already settled with a different txHash details: type: string description: >- Throw-site detail string supplementing the canonical message. Only set when the call site supplied an opts.message; absent otherwise. example: Hash JWT is not signed by the node account error: type: string description: >- RFC 6749 §5.2 / RFC 8628 §3.5 top-level OAuth error string. Present only on the OAuth device-polling responses from `POST /oauth/token` (`authorization_pending`, `slow_down`, `expired_token`, `access_denied`), so a standards-compliant OAuth/device client can branch on it directly instead of on the Nevermined `code`. Absent on every other error. example: authorization_pending hint: type: string description: >- Actionable remediation hint, sourced from the catalogue or supplied at the throw site. Tells the caller what to fix or where to look. example: >- Verify the wallet has sufficient balance and that the plan is active. docsUrl: type: string description: Permalink to the docs page describing this error code. example: >- https://nevermined.ai/docs/development-guide/api-errors/codes#bck-x402-0008 category: type: string description: >- Coarse classification of the failure, useful for client-side branching without parsing the message. enum: - validation - auth - business - integration - internal example: integration retryable: type: boolean description: >- Whether the failure is transient and the same call can be retried with identical inputs. Absent when the catalogue does not assert either way. example: true correlationId: type: string description: >- Request-scoped correlation id stamped by the global filter. Echoed in the x-correlation-id response header. Quote this when reporting issues. example: a3f6b1c4-7d2e-4a9b-8e0c-12f4d8e6c5b9 uuid: type: string description: >- Per-error UUID generated at construction. Useful for log correlation. example: e-550e8400-e29b-41d4-a716-446655440000 date: type: string description: ISO timestamp at which the error was constructed. example: '2026-05-09T12:34:56.789Z' format: date-time params: type: string description: >- JSON-stringified contextual parameters supplied at the throw site (e.g. IDs, state). Always a string in the wire format — parse with JSON.parse if needed. example: '{"planId":"43298432984329","reason":"Invalid configuration"}' required: - code - httpStatus - message securitySchemes: bearerAuth: type: http scheme: bearer description: >- Your Nevermined API Key (starts with 'nvm:'). Get one at [nevermined.app](https://nevermined.app) under **Settings > API Keys**. ```` ## Related topics - [Payment ledger](/docs/products/router/ledger.md) - [The x402 rail](/docs/products/router/rails-x402.md) - [How the Router works](/docs/products/router/how-it-works.md) - [Guardrails and error codes](/docs/products/router/guardrails.md) - [Publishing Static Resources](/docs/api-reference/python/resources-module.md)