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

# Effect an inbound PIX Automatico settlement debit

> Posts the real double-entry settlement debit on the payer's local ledger for a scheduled PIX Automatico payment (section 5.4.2, the plugin is the SGCT server). JDPI calls this after it confirms SPI settlement. The amount was established at schedule/block time, so the body carries no value. Returns the SGCT debit-operation id (idOperacaoSgct). A re-delivery resolves to a clean 200 with the prior confirmation, never a double post.



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml post /v1/pix-automatico/settlements/inbound/debit
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/pix-automatico/settlements/inbound/debit:
    post:
      tags:
        - PIX Automatico
      summary: Effect an inbound PIX Automatico settlement debit
      description: >-
        Posts the real double-entry settlement debit on the payer's local ledger
        for a scheduled PIX Automatico payment (section 5.4.2, the plugin is the
        SGCT server). JDPI calls this after it confirms SPI settlement. The
        amount was established at schedule/block time, so the body carries no
        value. Returns the SGCT debit-operation id (idOperacaoSgct). A
        re-delivery resolves to a clean 200 with the prior confirmation, never a
        double post.
      operationId: debitInboundPixAutomaticoSettlement
      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).
            examples:
              - Bearer eyJ...
            type: string
        - description: >-
            Idempotency key (= the endToEndId of the transaction). Mandatory per
            section 5.4.
          in: header
          name: Chave-Idempotencia
          required: true
          schema:
            description: >-
              Idempotency key (= the endToEndId of the transaction). Mandatory
              per section 5.4.
            examples:
              - E11111111202409181500y6j6mt9l1pi
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DebitScheduleBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DebitScheduleResponse'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    DebitScheduleBody:
      additionalProperties: true
      properties:
        dtContabil:
          description: Accounting date (aaaa-mm-dd).
          examples:
            - '2024-09-20'
          type: string
        dtHrEfetivacao:
          description: JDPI effectuation timestamp (UTC).
          examples:
            - '2024-09-20T04:00:01.001Z'
          type: string
        dtHrLiquidacao:
          description: SPI settlement timestamp (UTC).
          examples:
            - '2024-09-20T04:00:00.023Z'
          type: string
        endToEndId:
          description: Unique payment-instruction id (32-char).
          examples:
            - E11111111202409181500y6j6mt9l1pi
          type: string
        ispb:
          description: Payer participant ISPB (8 digits, a v5.5.0 string).
          examples:
            - '04358798'
          type: string
      required:
        - endToEndId
        - ispb
        - dtHrEfetivacao
        - dtContabil
        - dtHrLiquidacao
      type: object
    DebitScheduleResponse:
      additionalProperties: false
      properties:
        dtHrOperacaoSgct:
          description: SGCT operation timestamp (UTC).
          examples:
            - '2024-09-20T04:00:01.001Z'
          type: string
        endToEndId:
          description: Unique payment-instruction id (32-char).
          examples:
            - E11111111202409181500y6j6mt9l1pi
          type: string
        idOperacaoSgct:
          description: SGCT debit-operation id (the Midaz transaction id, a GUID).
          examples:
            - 58F752C5-6376-3252-8305-A2DE3A8525D3
          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).
          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
    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

````