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

# Settlement Adjustment

> Fired when a settlement adjustment (credit or debit) is applied to a transaction.



## AsyncAPI

````yaml specs/asyncapi-notify-v4.yaml TransactionRecipientPaymentNoticeSettlementAdjustment
id: TransactionRecipientPaymentNoticeSettlementAdjustment
title: Settlement Adjustment
description: >-
  Fired when a settlement adjustment (credit or debit) is applied to a
  transaction.
servers:
  - id: webhook
    protocol: https
    host: your-webhook-endpoint.example.com
    bindings: []
    variables: []
address: transaction.recipient.payment.notice.settlement.adjustment
parameters: []
bindings: []
operations:
  - &ref_0
    id: receiveTransactionRecipientPaymentNoticeSettlementAdjustment
    title: Receive transaction recipient payment notice settlement adjustment
    description: Settlement Adjustment
    type: receive
    messages:
      - &ref_1
        id: TransactionRecipientPaymentNoticeSettlementAdjustmentMessage
        contentType: application/json
        payload:
          - name: Settlement Adjustment
            type: object
            properties:
              - name: metadata
                type: object
                description: Delivery metadata present on every webhook event.
                required: true
                properties:
                  - name: id
                    type: string
                    description: >-
                      Ingo-assigned unique ID for this delivery. Use as your
                      idempotency key to deduplicate retries.
                    required: true
                  - name: topic
                    type: string
                    description: Topic name identifying the event type.
                    required: true
                  - name: topic_description
                    type: string
                    description: Human-readable description of the event.
                    required: true
                  - name: timestamp
                    type: integer
                    description: Unix timestamp of the webhook delivery.
                    required: true
                  - name: version
                    type: string
                    description: Payload contract version.
                    required: true
              - name: data
                type: object
                required: true
                properties:
                  - name: ancillary
                    type: object
                    description: >-
                      Transaction correlation identifiers for Notify webhook
                      events. Use these fields to match the event to a
                      transaction in your system.
                    required: true
                    properties:
                      - name: notification_id
                        type: string
                        description: >-
                          Ingo-assigned unique identifier for the staged
                          notification.
                        required: true
                      - name: session_id
                        type: string
                        description: Ingo-assigned session identifier, when applicable.
                        required: false
                      - name: participant_unique_id1
                        type: string
                        description: >-
                          Your primary correlation ID from the original Notify
                          request.
                        required: true
                      - name: participant_unique_id2
                        type: string
                        description: Your optional secondary correlation ID.
                        required: false
                      - name: party_id
                        type: string
                        description: >-
                          Ingo-assigned ID for the specific party this event
                          relates to. Present on multi-party (Notify v4) events.
                        required: false
                  - name: event
                    type: object
                    required: true
                    properties:
                      - name: status
                        type: string
                        description: Numeric status code for the event outcome.
                        required: true
                      - name: client_message
                        type: string
                        description: Human-readable description of the event outcome.
                        required: true
                      - name: attempt_count
                        type: integer
                        description: >-
                          Current delivery attempt number. Present when the
                          event type has a configurable attempt counter.
                        required: false
                      - name: max_attempts
                        type: integer
                        description: >-
                          Maximum allowed attempts. Present when the event type
                          has a configurable attempt counter.
                        required: false
                      - name: reason_code
                        type: string
                        description: Adjustment reason code.
                        required: true
                      - name: reason_description
                        type: string
                        description: Description associated with the reason code.
                        required: true
                      - name: adjustment_type
                        type: string
                        description: >-
                          "credit" — credits your settlement account. "debit" —
                          debits your settlement account.
                        enumValues:
                          - credit
                          - debit
                        required: true
                      - name: amount
                        type: string
                        description: Transaction amount.
                        required: true
                      - name: transaction_id
                        type: string
                        description: >-
                          Ingo-assigned unique transaction identifier for the
                          original transaction.
                        required: true
        headers: []
        jsonPayloadSchema:
          type: object
          required:
            - metadata
            - data
          properties:
            metadata:
              type: object
              required:
                - id
                - topic
                - topic_description
                - timestamp
                - version
              description: Delivery metadata present on every webhook event.
              properties:
                id:
                  type: string
                  maxLength: 50
                  description: >-
                    Ingo-assigned unique ID for this delivery. Use as your
                    idempotency key to deduplicate retries.
                  example: prod01-6aaa3079-c1ff-4cae-b77a-4b76026fc846
                  x-parser-schema-id: <anonymous-schema-2>
                topic:
                  type: string
                  maxLength: 150
                  description: Topic name identifying the event type.
                  x-parser-schema-id: <anonymous-schema-3>
                topic_description:
                  type: string
                  maxLength: 250
                  description: Human-readable description of the event.
                  x-parser-schema-id: <anonymous-schema-4>
                timestamp:
                  type: integer
                  description: Unix timestamp of the webhook delivery.
                  example: 1777509495
                  x-parser-schema-id: <anonymous-schema-5>
                version:
                  type: string
                  maxLength: 5
                  description: Payload contract version.
                  example: '1'
                  x-parser-schema-id: <anonymous-schema-6>
              x-parser-schema-id: WebhookMetadata
            data:
              type: object
              required:
                - ancillary
                - event
              properties:
                ancillary:
                  type: object
                  required:
                    - notification_id
                    - participant_unique_id1
                  description: >-
                    Transaction correlation identifiers for Notify webhook
                    events. Use these fields to match the event to a transaction
                    in your system.
                  properties:
                    notification_id:
                      type: string
                      maxLength: 15
                      description: >-
                        Ingo-assigned unique identifier for the staged
                        notification.
                      example: '10042781'
                      x-parser-schema-id: <anonymous-schema-8>
                    session_id:
                      type: string
                      maxLength: 50
                      nullable: true
                      description: Ingo-assigned session identifier, when applicable.
                      x-parser-schema-id: <anonymous-schema-9>
                    participant_unique_id1:
                      type: string
                      maxLength: 100
                      description: >-
                        Your primary correlation ID from the original Notify
                        request.
                      x-parser-schema-id: <anonymous-schema-10>
                    participant_unique_id2:
                      type: string
                      maxLength: 100
                      nullable: true
                      description: Your optional secondary correlation ID.
                      x-parser-schema-id: <anonymous-schema-11>
                    party_id:
                      type: string
                      maxLength: 36
                      nullable: true
                      description: >-
                        Ingo-assigned ID for the specific party this event
                        relates to. Present on multi-party (Notify v4) events.
                      x-parser-schema-id: <anonymous-schema-12>
                  x-parser-schema-id: NotifyCorrelation
                event:
                  allOf:
                    - type: object
                      required:
                        - status
                        - client_message
                      description: >-
                        Core event outcome fields present on every webhook
                        event. Additional event-specific properties may be
                        present — see the individual event documentation for the
                        complete schema.
                      properties:
                        status:
                          type: string
                          maxLength: 10
                          description: Numeric status code for the event outcome.
                          x-parser-schema-id: <anonymous-schema-13>
                        client_message:
                          type: string
                          maxLength: 250
                          description: Human-readable description of the event outcome.
                          x-parser-schema-id: <anonymous-schema-14>
                        attempt_count:
                          type: integer
                          description: >-
                            Current delivery attempt number. Present when the
                            event type has a configurable attempt counter.
                          example: 1
                          x-parser-schema-id: <anonymous-schema-15>
                        max_attempts:
                          type: integer
                          description: >-
                            Maximum allowed attempts. Present when the event
                            type has a configurable attempt counter.
                          example: 3
                          x-parser-schema-id: <anonymous-schema-16>
                      x-parser-schema-id: WebhookEventBase
                    - type: object
                      required:
                        - reason_code
                        - reason_description
                        - adjustment_type
                        - amount
                        - transaction_id
                      description: Settlement adjustment detail.
                      properties:
                        reason_code:
                          type: string
                          maxLength: 10
                          description: Adjustment reason code.
                          x-parser-schema-id: <anonymous-schema-188>
                        reason_description:
                          type: string
                          maxLength: 250
                          description: Description associated with the reason code.
                          x-parser-schema-id: <anonymous-schema-189>
                        adjustment_type:
                          type: string
                          maxLength: 20
                          description: >-
                            "credit" — credits your settlement account. "debit"
                            — debits your settlement account.
                          enum:
                            - credit
                            - debit
                          x-parser-schema-id: <anonymous-schema-190>
                        amount:
                          type: string
                          maxLength: 10
                          description: Transaction amount.
                          x-parser-schema-id: <anonymous-schema-191>
                        transaction_id:
                          type: string
                          maxLength: 15
                          description: >-
                            Ingo-assigned unique transaction identifier for the
                            original transaction.
                          x-parser-schema-id: <anonymous-schema-192>
                      x-parser-schema-id: EventSettlementAdjustment
                  x-parser-schema-id: <anonymous-schema-187>
              x-parser-schema-id: <anonymous-schema-186>
          x-parser-schema-id: <anonymous-schema-185>
        title: Settlement Adjustment
        example: No examples found
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: TransactionRecipientPaymentNoticeSettlementAdjustmentMessage
    bindings: []
    extensions:
      - id: x-parser-unique-object-id
        value: TransactionRecipientPaymentNoticeSettlementAdjustment
sendOperations:
  - *ref_0
receiveOperations: []
sendMessages:
  - *ref_1
receiveMessages: []
extensions:
  - id: x-parser-unique-object-id
    value: TransactionRecipientPaymentNoticeSettlementAdjustment
securitySchemes: []

````