> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Settle a refund with an aggregated block devolution (Phase 1)

> Initiates exactly one aggregated devolution for all PENDING blocks linked to the refund infraction report and changes those blocks together to SETTLING. Processing is selected automatically from the infraction operation type and contested transaction format. The refund remains OPEN during this phase. The request has no body. A successful SPI response reports SETTLING, or SETTLED for an idempotent replay; rejected or unexpected outcomes return an error. Only the requesting participant tenant may settle its own refund.



## OpenAPI

````yaml en/openapi/v3-current/pix-lerian-dict.yaml POST /dict/refunds/{id}/settle
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Public API for Pix keys, claims, fraud markers, infraction reports, and MED
    funds recovery.
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
  title: Pix Lerian — DICT
  version: release-candidate
servers:
  - url: https://api.example.com/dict-hub/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Register, retrieve, list, update, and remove Pix keys.
    name: Entries
  - description: Look up Pix keys and check whether keys exist in the DICT directory.
    name: Keys
  - description: Manage ownership and portability claims for Pix keys.
    name: Claims
  - description: Manage participant-scoped MED 2.0 funds recoveries.
    name: Funds Recoveries
  - description: Manage MED 2.0 infraction reports for the authenticated organization.
    name: Infraction Reports
  - description: Create, query, cancel, and settle MED 2.0 refunds.
    name: Refunds
  - description: Create, query, list, and cancel DICT fraud markers.
    name: Fraud Markers
paths:
  /dict/refunds/{id}/settle:
    post:
      tags:
        - Refunds
      summary: Settle a refund with an aggregated block devolution (Phase 1)
      description: >-
        Initiates exactly one aggregated devolution for all PENDING blocks
        linked to the refund infraction report and changes those blocks together
        to SETTLING. Processing is selected automatically from the infraction
        operation type and contested transaction format. The refund remains OPEN
        during this phase. The request has no body. A successful SPI response
        reports SETTLING, or SETTLED for an idempotent replay; rejected or
        unexpected outcomes return an error. Only the requesting participant
        tenant may settle its own refund.
      operationId: settleRefund
      parameters:
        - description: Client-generated key used to retry exactly the same request safely.
          in: header
          name: Idempotency-Key
          required: true
          schema:
            maxLength: 64
            minLength: 1
            type: string
            description: >-
              Client-generated key used to retry exactly the same request
              safely.
          example: pix-demo-20260903-000001
        - description: Refund internal ID (UUID format)
          in: path
          name: id
          required: true
          schema:
            description: Refund internal ID (UUID format)
            examples:
              - 018f8c1d-1234-7abc-9def-000000000010
            type: string
          example: 01960718-a213-2435-6078-901234567123
        - description: >-
            Best-effort business correlation id (observability only; never
            fabricated).
          in: header
          name: X-Correlation-Id
          schema:
            description: >-
              Best-effort business correlation id (observability only; never
              fabricated).
            type: string
          example: 019606a1-3b4c-7d8e-9f01-234567890abc
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SettleRefundView'
              examples:
                fictitiousExample:
                  summary: Fictitious example
                  value:
                    alreadySettled: '50.00'
                    blocks:
                      - amount: '120.00'
                        lockId: b0f5c2a1-9e3d-4c7a-8f21-1a2b3c4d5e6f
                        spiBlockId: 7c9a1b2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d
                    blocksStatus: SETTLING
                    endToEndId: 019606a1-3b4c-7d8e-9f01-234567890abc
                    operationType: ROOT
                    originalAmount: '200.00'
                    refundId: 018f8c1d-1234-7abc-9def-000000000010
                    settleAmount: '150.00'
                    settleReason: FR01
                    settleType: REFUND
                    settled: false
                    status: OPEN
                    surplusAmount: '50.00'
          description: Accepted
        '400':
          content:
            application/json:
              example:
                code: PIX-0030
                title: Idempotency Key Required
                message: >-
                  The Idempotency-Key header is required for this operation and
                  must be within the accepted length.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
          description: >-
            Idempotency-Key absent or longer than 64 bytes (PIX-0030). Legacy
            {code,title,message} envelope, NOT problem+json.
        '412':
          content:
            application/json:
              example:
                code: PIX-0031
                title: Idempotency Key Conflict
                message: The Idempotency-Key was already used with a different request.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
          description: >-
            Idempotency-Key replayed with a divergent request -- a different
            method, URL (including the path parameter), body, or identity header
            among X-Account-Id / X-Reason / X-End-To-End-Id (PIX-0031). Legacy
            {code,title,message} envelope, NOT problem+json.
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      x-codeSamples:
        - lang: bash
          label: cURL with fictitious data
          source: |-
            curl --request POST \
              --url https://api.example.com/dict-hub/v1/dict/refunds/01960718-a213-2435-6078-901234567123/settle \
              --header 'Authorization: Bearer demo-access-token' \
              --header 'Idempotency-Key: pix-demo-20260903-000001' \
              --header 'X-Correlation-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'
components:
  schemas:
    SettleRefundView:
      additionalProperties: false
      properties:
        alreadySettled:
          examples:
            - '50.00'
          type: string
        blocks:
          items:
            $ref: '#/components/schemas/SettleBlockView'
          type:
            - array
            - 'null'
        blocksStatus:
          enum:
            - SETTLING
            - PENDING
            - SETTLED
          examples:
            - SETTLING
          type: string
        endToEndId:
          type: string
        operationType:
          enum:
            - ROOT
            - SUBSEQUENT
            - UNKNOWN
          examples:
            - ROOT
          type: string
        originalAmount:
          examples:
            - '200.00'
          type: string
        refundId:
          examples:
            - 018f8c1d-1234-7abc-9def-000000000010
          type: string
        settleAmount:
          examples:
            - '150.00'
          type: string
        settleReason:
          examples:
            - FR01
          type: string
        settleType:
          enum:
            - REFUND
            - MANUAL
          examples:
            - REFUND
          type: string
        settled:
          examples:
            - false
          type: boolean
        status:
          enum:
            - OPEN
            - CLOSED
            - CANCELLED
          examples:
            - OPEN
          type: string
        surplusAmount:
          examples:
            - '50.00'
          type: string
      required:
        - refundId
        - status
        - operationType
        - originalAmount
        - alreadySettled
        - blocksStatus
      type: object
    LegacyErrorEnvelope:
      additionalProperties: false
      properties:
        code:
          description: PIX-XXXX error code
          type: string
        message:
          description: Human-readable error message
          type: string
        title:
          description: Short error title
          type: string
      required:
        - code
        - title
        - message
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    SettleBlockView:
      additionalProperties: false
      properties:
        amount:
          examples:
            - '120.00'
          type: string
        lockId:
          examples:
            - b0f5c2a1-9e3d-4c7a-8f21-1a2b3c4d5e6f
          type: string
        spiBlockId:
          examples:
            - 7c9a1b2d-3e4f-5a6b-7c8d-9e0f1a2b3c4d
          type: string
      required:
        - lockId
        - spiBlockId
        - amount
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````