> ## 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.

# Reverse an inbound Pix Automático settlement debit

> Reverses the prior settlement debit (or releases a still-pending hold) on a negative SPI return. The reverse is parameterizable and disabled by default. Returns the settlement-gateway reversal-operation id (idOperacaoSgct).



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml DELETE /v1/pix-automatico/settlements/inbound/debit/{endToEndId}
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/pix-automatico/settlements/inbound/debit/{endToEndId}:
    delete:
      tags:
        - Pix Automático API
      summary: Reverse an inbound Pix Automático settlement debit
      description: >-
        Reverses the prior settlement debit (or releases a still-pending hold)
        on a negative SPI return. The reverse is parameterizable and disabled by
        default. Returns the settlement-gateway reversal-operation id
        (idOperacaoSgct).
      parameters:
        - description: >-
            Bearer access token (the financial-ingress gate; the handler fails
            closed with Pix-0082 when absent).
          in: header
          name: Authorization
          schema:
            description: >-
              Bearer access token (the financial-ingress gate; the handler fails
              closed with Pix-0082 when absent).
            type: string
        - description: Idempotency key (= the endToEndId of the transaction). Mandatory per
          in: header
          name: Chave-Idempotencia
          required: true
          schema:
            description: >-
              Idempotency key (= the endToEndId of the transaction). Mandatory
              per
            type: string
        - description: Unique payment-instruction id (32-char), the natural key.
          in: path
          name: endToEndId
          required: true
          schema:
            description: Unique payment-instruction id (32-char), the natural key.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReverseDebitBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReverseDebitResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    ReverseDebitBody:
      additionalProperties: false
      properties:
        codigoErro:
          description: Error code.
          type: string
        descCodigoErro:
          description: Error description (1000-char).
          type: string
        endToEndId:
          description: Unique payment-instruction id (32-char; matches the path param).
          type: string
        stJdPiProc:
          description: Negative-return classification.
          format: int64
          type: integer
      required:
        - endToEndId
        - stJdPiProc
        - codigoErro
      type: object
    ReverseDebitResponse:
      additionalProperties: false
      properties:
        dtHrOperacaoSgct:
          description: settlement-gateway operation timestamp (UTC).
          type: string
        endToEndId:
          description: Unique payment-instruction id (32-char).
          type: string
        idOperacaoSgct:
          description: settlement-gateway reversal-operation id (a GUID).
          type: string
      required:
        - endToEndId
        - idOperacaoSgct
        - dtHrOperacaoSgct
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          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.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          format: uri
          type: string
      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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````