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

# Decide a sent Pix held in fraud analysis

> The antifraud partner, through the client's M2M application, or a person of the client, decides a sent Pix that Pix Lerian holds in fraud analysis (status `FRAUD_ANALYSIS`, announced by the `outbound_transfer.fraud_analysis` event).

`ALLOW` sends the Pix as a normal payment. The transfer answers `PROCESSING` and ends as `COMPLETED` or `REJECTED` like any sent Pix. `DENY` reverses the debit, returns the usage limit, and closes the transfer `REJECTED`. The first final decision wins. The record shows who decided: `fraudCheck.resolutionOrigin` is `PARTNER` or `OPERATOR`, and `fraudCheck.resolvedBy` is the subject of the token. A person of the client must send a `justification` of 10 to 500 characters. Pix Lerian never returns it and never publishes it in an event.

A `200` with `PROCESSING` is an `ALLOW` taken, and also the answer to a repeat of an `ALLOW` already taken. A `200` with `REJECTED` is a `DENY` taken, a repeat of a `DENY` already taken, or an `ALLOW` whose order the rail refused or never received: the debit is reversed and `fraudCheck.resolution` stays `ALLOW`.

A `404` (`PIX-0340`) means that the tenant has no such sent transfer. A `409` (`PIX-0339`) means that the transfer is not held in analysis, that another decision, the payer's cancel or the deadline ended it first, or that `analysisId` names another analysis. A `409` (`PIX-0344`) means an `ALLOW` after `decideBy`: a `DENY` is still accepted. A `422` (`PIX-0343`) means that the body is outside the contract, or that a person sent no `justification`. A `503` (`PIX-0345`) means that Pix Lerian is still recording the hold: retry after the `Retry-After` time. A `500` (`PIX-0000`) means either that a `DENY` has no recorded debit reversal yet, so the decision is taken and Pix Lerian closes the transfer `REJECTED`, or that nothing changed and the same call can repeat.



## OpenAPI

````yaml /es/openapi/v3-current/pix-lerian-spi.yaml post /transfers/{id}/fraud-decision
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: Public API for outbound Pix transfers, refunds, and scheduled payments.
  license:
    name: Lerian Studio General License
  title: Pix Lerian — Payments
  version: 1.5.0
servers:
  - url: https://api.example.com/spi/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Create, list, and retrieve Pix refunds.
    name: Refunds
  - name: Scheduled Payments
    description: Register, list, retrieve, and cancel scheduled Pix payments.
  - description: >-
      Initiate, process, list, and retrieve outbound Pix transfers, and cancel
      or decide a sent Pix held in fraud analysis.
    name: Transfers
  - description: >-
      Register, list, retrieve, and cancel recurring series of scheduled Pix
      payments.
    name: Scheduled Payment Recurrences
  - description: >-
      Hold the funds of a received Pix in a cautionary block (MED 2.0), return
      them to the payer, or give them back to the account holder.
    name: Balance Locks
  - description: Read the APIX001 report of a closed month.
    name: APIX001 Reports
  - description: Close a reference month into an immutable report, and reopen it.
    name: APIX001 Periods
  - description: >-
      Record and correct the facts that only the participant knows, for the
      APIX001 report.
    name: APIX Client Facts
  - description: >-
      Declare the indirect participants that the tenant settles for, and end the
      declarations.
    name: APIX Settled Participants
paths:
  /transfers/{id}/fraud-decision:
    post:
      tags:
        - Transfers
      summary: Decide a sent Pix held in fraud analysis
      description: >-
        The antifraud partner, through the client's M2M application, or a person
        of the client, decides a sent Pix that Pix Lerian holds in fraud
        analysis (status `FRAUD_ANALYSIS`, announced by the
        `outbound_transfer.fraud_analysis` event).


        `ALLOW` sends the Pix as a normal payment. The transfer answers
        `PROCESSING` and ends as `COMPLETED` or `REJECTED` like any sent Pix.
        `DENY` reverses the debit, returns the usage limit, and closes the
        transfer `REJECTED`. The first final decision wins. The record shows who
        decided: `fraudCheck.resolutionOrigin` is `PARTNER` or `OPERATOR`, and
        `fraudCheck.resolvedBy` is the subject of the token. A person of the
        client must send a `justification` of 10 to 500 characters. Pix Lerian
        never returns it and never publishes it in an event.


        A `200` with `PROCESSING` is an `ALLOW` taken, and also the answer to a
        repeat of an `ALLOW` already taken. A `200` with `REJECTED` is a `DENY`
        taken, a repeat of a `DENY` already taken, or an `ALLOW` whose order the
        rail refused or never received: the debit is reversed and
        `fraudCheck.resolution` stays `ALLOW`.


        A `404` (`PIX-0340`) means that the tenant has no such sent transfer. A
        `409` (`PIX-0339`) means that the transfer is not held in analysis, that
        another decision, the payer's cancel or the deadline ended it first, or
        that `analysisId` names another analysis. A `409` (`PIX-0344`) means an
        `ALLOW` after `decideBy`: a `DENY` is still accepted. A `422`
        (`PIX-0343`) means that the body is outside the contract, or that a
        person sent no `justification`. A `503` (`PIX-0345`) means that Pix
        Lerian is still recording the hold: retry after the `Retry-After` time.
        A `500` (`PIX-0000`) means either that a `DENY` has no recorded debit
        reversal yet, so the decision is taken and Pix Lerian closes the
        transfer `REJECTED`, or that nothing changed and the same call can
        repeat.
      operationId: decideFraudAnalysis
      parameters:
        - description: >-
            Transfer UUID: the id of the outbound_transfer.fraud_analysis event,
            which the antifraud partner also holds as the key of its evaluation
          in: path
          name: id
          required: true
          schema:
            description: >-
              Transfer UUID: the id of the outbound_transfer.fraud_analysis
              event, which the antifraud partner also holds as the key of its
              evaluation
            examples:
              - 01a18811-6b64-7a10-b2c3-d4e5f6071829
            type: string
      requestBody:
        content:
          application/json:
            examples: {}
            schema:
              $ref: '#/components/schemas/FraudDecisionBody'
      responses:
        '200':
          content:
            application/json:
              example:
                id: 01a18811-6b64-7a10-b2c3-d4e5f6071829
                accountId: 019cadd4-5620-7c2d-8e3f-4a5b6c7d8e9f
                endToEndId: E12345678202611181400AbCdEf12345
                status: REJECTED
                type: OUTBOUND
                initiationType: DICT
                source:
                  account:
                    branch: '0001'
                    number: '9988776'
                    participant: '12345678'
                    type: CACC
                  owner:
                    document: '52998224725'
                    name: Joao Pereira
                    type: NATURAL_PERSON
                destination:
                  account:
                    branch: '0001'
                    number: '1112223'
                    participant: '87654321'
                    type: CACC
                  owner:
                    document: '11144477735'
                    name: Maria Souza
                    type: NATURAL_PERSON
                amount: '100.17'
                currency: BRL
                fraudCheck:
                  decision: REVIEW
                  origin: PROVIDER
                  analysisId: an-7f3a
                  decideBy: '2026-11-18T14:30:00Z'
                  resolution: DENY
                  resolutionOrigin: OPERATOR
                  resolvedBy: user-1
                ledger:
                  transactionId: 01a18826-1aff-7d11-a2b3-c4d5e6f70819
                  revert:
                    transactionId: 01a18826-9c20-7e41-b2c3-d4e5f6071a2b
                createdAt: '2026-11-18T14:00:05.412Z'
                updatedAt: '2026-11-18T14:12:41.087Z'
              schema:
                $ref: '#/components/schemas/TransferResponse'
          description: OK
        '400':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0015
                title: Bad Request
                status: 400
                detail: One or more path parameters are invalid.
                code: PIX-0015
              schema:
                $ref: '#/components/schemas/Detail'
          description: A transfer id that is not a UUID (PIX-0015).
        '401':
          description: >-
            Missing, malformed or expired bearer token, refused ahead of this
            operation by the authorization middleware in the legacy
            {code,title,message} envelope over application/json, with the
            generic client-error code PIX-0010. In a multi-tenant deployment the
            tenant middleware refuses a token it cannot read, or one with no
            usable tenantId claim, in the same shape with a code outside the
            PIX-NNNN catalogue: MISSING_TOKEN, INVALID_TOKEN, MISSING_TENANT or
            INVALID_TENANT. Branch on the status, not the body code.
        '403':
          description: >-
            The token lacks the permission this operation's resource and action
            require, refused ahead of it by the authorization middleware in the
            legacy {code,title,message} envelope over application/json, with the
            generic client-error code PIX-0010. The tenant middlewares also
            answer 403 with a code outside the PIX-NNNN catalogue:
            TENANT_SUSPENDED or TENANT_ACCESS_DENIED in a multi-tenant
            deployment, in the same shape, and TENANT_CONFIG_NOT_FOUND, in a
            {code,message} body, when the tenant's configuration cannot be
            resolved. Branch on the status, not the body code.
        '404':
          content:
            application/json:
              example:
                code: TENANT_NOT_FOUND
                title: Tenant Not Found
                message: 'tenant not found: 019606a1-3b4c-7d8e-9f01-234567890abc'
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0340
                title: Not Found
                status: 404
                detail: Transfer ID does not exist for this organization.
                code: PIX-0340
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            No sent transfer with this id exists for the tenant (PIX-0340). The
            middleware ahead of this operation answers this status too (see
            default), in the legacy {code,title,message} envelope over
            application/json, NOT problem+json.
        '409':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0339
                title: Conflict
                status: 409
                detail: >-
                  The transfer is not held in fraud analysis: it was never held,
                  its analysis already ended (cancelled, expired or decided), or
                  the call names another analysis. GET the transfer for its
                  current state.
                code: PIX-0339
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            The transfer is not held in fraud analysis: it was never held, its
            analysis already ended by a decision, the payer's cancel or the
            deadline, or the call names another analysis (PIX-0339); or an ALLOW
            after decideBy, after which Pix Lerian reverses the debit and closes
            the transfer REJECTED (PIX-0344).
        '422':
          content:
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0343
                title: Unprocessable Entity
                status: 422
                detail: >-
                  The decision is not valid: it needs analysisId and decision
                  ALLOW or DENY, in a body within 16 KiB, and a person of the
                  client also needs a justification of 10 to 500 characters.
                code: PIX-0343
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            A body outside the contract: no analysisId, a decision that is not
            ALLOW or DENY, more than 16 KiB; or a person of the client without a
            justification of 10 to 500 characters (PIX-0343).
        '500':
          content:
            application/json:
              example:
                code: PIX-0000
                title: Internal Server Error
                message: >-
                  The server encountered an unexpected error. Please try again
                  later.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0000
                title: Internal Server Error
                status: 500
                detail: >-
                  The server could not complete the request. Please try again
                  later.
                code: PIX-0000
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Unexpected server error, or a DENY whose debit reversal is not
            recorded yet (PIX-0000). The decision is taken once the transfer is
            PENDING with fraudCheck.resolution DENY, or REJECTED: GET the
            transfer; Pix Lerian closes it REJECTED. The middleware ahead of
            this operation answers this status too (see default), in the legacy
            {code,title,message} envelope over application/json, NOT
            problem+json.
        '503':
          content:
            application/json:
              example:
                code: PIX-0000
                title: Internal Server Error
                message: >-
                  The server encountered an unexpected error. Please try again
                  later.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
            application/problem+json:
              example:
                type: https://errors.lerian.studio/v1/PIX-0345
                title: Service Unavailable
                status: 503
                detail: >-
                  The server could not complete the request. Please try again
                  later.
                code: PIX-0345
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            The hold is still being recorded by the request that created it:
            retry after Retry-After seconds (PIX-0345). The middleware ahead of
            this operation answers this status too (see default), in the legacy
            {code,title,message} envelope over application/json, NOT
            problem+json.
        default:
          content:
            application/json:
              example:
                code: PIX-0000
                title: Internal Server Error
                message: >-
                  The server encountered an unexpected error. Please try again
                  later.
              schema:
                $ref: '#/components/schemas/LegacyErrorEnvelope'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Error. Middleware ahead of this operation also refuses in the legacy
            {code,title,message} envelope over application/json: a body over the
            server's 4 MiB limit with 413 PIX-0010; a query value holding the
            NUL character (%00) or invalid UTF-8 with 400 PIX-0020; the Access
            Manager unavailable (503) or timing out (504) with PIX-0000; and, in
            a multi-tenant deployment, the tenant middleware with 404
            TENANT_NOT_FOUND, 500 TENANT_DB_ERROR, 503
            TENANT_MANAGER_UNAVAILABLE or SERVICE_UNAVAILABLE, and 504
            TENANT_MANAGER_TIMEOUT. Branch on the status; these middleware 503
            and 504 refusals are retryable. Any operation that uses the database
            also answers 503 PIX-0062 when its Postgres connection is lost; that
            request may or may not have been processed, so repeat it only as
            this operation's own guidance for an unknown outcome allows.
components:
  schemas:
    FraudDecisionBody:
      additionalProperties: false
      properties:
        analysisId:
          description: >-
            The partner's identifier of the analysis held: the
            fraudCheck.analysisId of the outbound_transfer.fraud_analysis event.
          examples:
            - an-7f3a
          maxLength: 64
          minLength: 1
          type: string
        decision:
          description: >-
            ALLOW sends the Pix. DENY reverses the debit and closes the transfer
            REJECTED. REVIEW is never a decision.
          enum:
            - ALLOW
            - DENY
          examples:
            - ALLOW
          type: string
        justification:
          description: >-
            Required from a person of the client (10 to 500 characters after
            trimming), ignored for the application of the partner. Pix Lerian
            keeps it for audit, never returns it and never publishes it in an
            event.
          examples:
            - Payee confirmed by phone with the payer.
          maxLength: 500
          minLength: 10
          type: string
        reasons:
          description: >-
            The partner's most recent reasons: when present they replace the
            reasons of the REVIEW. Read from a partner's application only; a
            person never changes them.
          items:
            $ref: '#/components/schemas/FraudCheckReasonResponse'
          type:
            - array
            - 'null'
      required:
        - analysisId
        - decision
      type: object
    TransferResponse:
      additionalProperties: false
      properties:
        accountId:
          examples:
            - 019606a0-1a2b-7c3d-8e4f-567890123abc
          type: string
        aliasId:
          type: string
        alreadyRefundedAmount:
          description: >-
            Cross-mechanism settled and reserved refund amount. Returned only
            for INBOUND transfers.
          examples:
            - '60.00'
          type: string
        amount:
          examples:
            - '100.00'
          type: string
        createdAt:
          examples:
            - '2026-05-06T10:30:00Z'
          format: date-time
          type: string
        currency:
          examples:
            - BRL
          type: string
        deletedAt:
          format: date-time
          type: string
        description:
          examples:
            - Pagamento de aluguel
          type: string
        destination:
          $ref: '#/components/schemas/SourceDestination'
        endToEndId:
          examples:
            - E12345678202605061030abcdef12345
          type: string
        feeCharge:
          $ref: '#/components/schemas/FeeChargeResponse'
          description: >-
            Fee the ledger reported on the transfer. Absent when the ledger's
            fee answer was not recorded for this transfer (an error logged at
            the time, or a transfer created before fees were read back);
            {"applied": false} when the ledger reported that no fee was charged;
            the full object when it charged one.
        fraudCheck:
          $ref: '#/components/schemas/FraudCheckResponse'
          description: >-
            The antifraud partner's answer for a Pix, as the partner gave it.
            Present on a transfer that the institution's antifraud partner
            evaluated: a received Pix that was approved, or a sent Pix, allowed
            or refused. Absent when the flow is off and on Pix Automático
            settlements.
        id:
          examples:
            - 019606a2-4c5d-7e8f-90a1-345678901bcd
          type: string
        initiatedAt:
          examples:
            - '2026-05-06T10:30:00Z'
          format: date-time
          type: string
        initiationType:
          examples:
            - DICT
          type: string
        ledger:
          $ref: '#/components/schemas/LedgerInfo'
        metadata:
          additionalProperties: {}
          type: object
        paymentType:
          examples:
            - PIX
          type: string
        purpose:
          examples:
            - IACT
          type: string
        remainingRefundableAmount:
          description: >-
            Amount minus alreadyRefundedAmount. Returned only for INBOUND
            transfers and can be negative.
          examples:
            - '40.00'
          type: string
        source:
          $ref: '#/components/schemas/SourceDestination'
        status:
          examples:
            - COMPLETED
          type: string
        type:
          examples:
            - OUTBOUND
          type: string
        updatedAt:
          examples:
            - '2026-05-06T10:30:05Z'
          format: date-time
          type: string
        urgency:
          examples:
            - HIGH
          type: string
      required:
        - id
        - endToEndId
        - status
        - type
        - amount
        - createdAt
        - updatedAt
      type: object
    Detail:
      additionalProperties: true
      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.
          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
    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
        fields:
          additionalProperties:
            type: string
          description: Per-field detail, keyed by the field or header the refusal names
          type: object
        headers:
          additionalProperties:
            type: string
          description: Per-header detail, keyed by the request header the refusal names
          type: object
      required:
        - code
        - title
        - message
      type: object
    FraudCheckReasonResponse:
      additionalProperties: false
      properties:
        code:
          description: The partner's reason code.
          examples:
            - R01
          type: string
        description:
          description: The partner's free-text description of the reason, as received.
          examples:
            - Known payer
          type: string
      required:
        - code
      type: object
    SourceDestination:
      additionalProperties: false
      properties:
        account:
          $ref: '#/components/schemas/AccountDetails'
        key:
          examples:
            - '+5511999998888'
          type: string
        owner:
          $ref: '#/components/schemas/OwnerDetails'
      type: object
    FeeChargeResponse:
      additionalProperties: false
      properties:
        applied:
          examples:
            - true
          type: boolean
          description: >-
            Whether the ledger charged a fee on the create that moved the
            operation's money. When false, no other field is present. applied
            reports what the create did and the object is kept as its record.
            Where the operation carries ledger.revert (transfers only: REJECTED,
            or FAILED after the debit was reverted), the revert inverted the fee
            legs with the amount, so the fee was returned; on a transfer without
            ledger.revert, feeCharge says nothing about the fee's final
            position.
        calculationType:
          examples:
            - LEDGER
          type: string
          description: >-
            How the total fee was calculated. LEDGER when the ledger's fee
            package computed it.
        fees:
          items:
            $ref: '#/components/schemas/FeeEntryResponse'
          type:
            - array
            - 'null'
          description: >-
            Individual fee entries that make up the total, one per ledger fee
            leg.
        netAmount:
          examples:
            - '100.00'
          type: string
          description: >-
            Amount that reached the destination: on an outbound operation what
            the ledger moved to the rail, on an inbound one what it credited to
            the receiving account (the operation's amount when the ledger
            reported no such leg; on an outbound operation a deductible fee
            package, a misconfiguration on a Pix ledger, makes it lower than the
            amount).
        totalAmount:
          examples:
            - '1.50'
          type: string
          description: Sum of every fee entry the ledger charged on the operation.
      required:
        - applied
      type: object
    FraudCheckResponse:
      additionalProperties: false
      properties:
        analysisId:
          description: The partner's identifier of the analysis.
          examples:
            - an-7f3a
          type: string
        cause:
          description: >-
            Why the partner did not decide, such as TIMEOUT or UNAVAILABLE.
            Absent when origin is PROVIDER.
          examples:
            - TIMEOUT
          type: string
        decideBy:
          description: >-
            Deadline of an analysis that the partner left open on a sent Pix,
            RFC 3339. Present only while or after Pix Lerian held the Pix for
            review.
          examples:
            - '2026-11-18T14:30:00Z'
          format: date-time
          type: string
        decision:
          description: >-
            Outcome of the check. On a received Pix that exists as a transfer it
            is ALLOW: a refusal leaves no transfer. On a sent Pix it is ALLOW
            when the order went to the rail, DENY or REVIEW when Pix Lerian
            refused it and reversed the debit, and REVIEW while Pix Lerian holds
            the Pix for review (status FRAUD_ANALYSIS).
          enum:
            - ALLOW
            - REVIEW
            - DENY
          examples:
            - ALLOW
          type: string
        origin:
          description: >-
            PROVIDER when the partner decided. FALLBACK when the partner did not
            decide and the posture of the route answered: an open posture
            allows, and a closed one denies.
          enum:
            - PROVIDER
            - FALLBACK
          examples:
            - PROVIDER
          type: string
        reasons:
          description: Reasons the partner returned, as received.
          items:
            $ref: '#/components/schemas/FraudCheckReasonResponse'
          type:
            - array
            - 'null'
        resolution:
          description: >-
            How an analysis held for review ended: ALLOW or DENY by the decision
            of the antifraud partner or of the client's operator, CANCELLED by
            the payer, EXPIRED at the deadline. Absent while the Pix is held and
            when it was never held.
          enum:
            - ALLOW
            - DENY
            - CANCELLED
            - EXPIRED
          examples:
            - CANCELLED
          type: string
        resolutionOrigin:
          description: >-
            Who decided an ALLOW or DENY: PARTNER when the antifraud partner's
            application did, OPERATOR when a person of the client did. Absent
            for CANCELLED, EXPIRED and a Pix never held.
          enum:
            - PARTNER
            - OPERATOR
          examples:
            - PARTNER
          type: string
        resolvedBy:
          description: >-
            The subject of the token that decided an ALLOW or DENY. Absent for
            CANCELLED, EXPIRED and a Pix never held.
          examples:
            - user-1
          type: string
        score:
          description: >-
            The partner's score, as text exactly as the partner sent it. Opaque
            to the SPI.
          examples:
            - '0.12'
          type: string
      required:
        - decision
        - origin
      type: object
    LedgerInfo:
      additionalProperties: false
      properties:
        destinationOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf1
          type: string
        revert:
          $ref: '#/components/schemas/LedgerRevertInfo'
        sourceOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf0
          type: string
        transactionId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdef
          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
    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
    AccountDetails:
      additionalProperties: false
      properties:
        branch:
          examples:
            - '0001'
          type: string
        number:
          examples:
            - '0007654321'
          type: string
        participant:
          examples:
            - '87654321'
          type: string
        type:
          examples:
            - CACC
          type: string
      required:
        - branch
        - number
        - participant
        - type
      type: object
    OwnerDetails:
      additionalProperties: false
      properties:
        document:
          examples:
            - '12345678901'
          type: string
        name:
          examples:
            - João da Silva
          type: string
        tradeName:
          examples:
            - Empresa Exemplo LTDA
          type: string
        type:
          examples:
            - NATURAL_PERSON
          type: string
      required:
        - document
        - name
      type: object
    FeeEntryResponse:
      additionalProperties: false
      properties:
        amount:
          examples:
            - '1.50'
          type: string
          description: Amount of this fee entry.
        calculationType:
          examples:
            - LEDGER
          type: string
          description: >-
            How this entry was calculated. LEDGER when the ledger's fee package
            computed it.
        calculationValue:
          type: string
          description: >-
            Raw value the calculation was parameterised with. Absent when
            calculationType is LEDGER.
        creditAccount:
          examples:
            - '@fees-pix'
          type: string
          description: Ledger account credited with this fee entry.
        feeLabel:
          examples:
            - LEDGER_FEE
          type: string
          description: >-
            Label of this fee entry. LEDGER_FEE on every entry the ledger
            reported: its answer names no fee, so creditAccount is what
            distinguishes one entry from another.
      required:
        - feeLabel
        - amount
      type: object
    LedgerRevertInfo:
      additionalProperties: false
      properties:
        destinationOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf1
          type: string
        sourceOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf0
          type: string
        transactionId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdef
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.