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

# Transfer funds from a client to an institution for a retail operation

> Issues a PAG0142 "IF requisita Transferência de recursos de cliente para IF por conta de operação de varejo" to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds from a client to another financial institution on account of a retail operation. The instruction is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (PAG0142R1) arrives asynchronously and is read back with getPAG0142. Every amount is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running answers 503 with SILOC-0024.



## OpenAPI

````yaml /pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/retail-client-to-institution-transfers
openapi: 3.1.0
info:
  description: >-
    OpenAPI 3.1 surface for Lerian SILOC, the participant-side rail connecting
    the institution to Núclea's SILOC deferred-net interbank settlement.
  title: Lerian SILOC API
  version: 1.0.0
servers:
  - url: https://siloc.sandbox.lerian.net
security: []
paths:
  /api/v1/siloc/outbound/retail-client-to-institution-transfers:
    post:
      tags:
        - Transfers
      summary: Transfer funds from a client to an institution for a retail operation
      description: >-
        Issues a PAG0142 "IF requisita Transferência de recursos de cliente para
        IF por conta de operação de varejo" to the Câmara PAG (Catálogo de
        Serviços do SFN v5.13, Vol II). Requests a transfer of funds from a
        client to another financial institution on account of a retail
        operation. The instruction is minted, built, signed, encrypted and
        durably recorded BEFORE anything reaches the queue, so this returns 202
        with the control number the câmara will echo; the answer (PAG0142R1)
        arrives asynchronously and is read back with getPAG0142. Every amount is
        a decimal STRING carried to the wire exactly as written. A deployment
        with no send leg configured answers 503 with SILOC-0023; one whose
        dispatcher is not running answers 503 with SILOC-0024.
      operationId: submitPAG0142
      parameters:
        - description: >-
            Idempotency key for this state-changing request (required, max 255
            characters).
          in: header
          name: X-Idempotency
          required: true
          schema:
            description: >-
              Idempotency key for this state-changing request (required, max 255
              characters).
            maxLength: 255
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PAG0142Payload'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagTransferBodyPAG0142Payload'
          description: Accepted
        '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
      security:
        - BearerAuth: []
components:
  schemas:
    PAG0142Payload:
      additionalProperties: false
      properties:
        AgCredtd:
          description: Agência Creditada (Agencia, [0..1]).
          type: string
        AgDebtd:
          description: Agência Debitada (Agencia, [0..1]).
          type: string
        CNPJ_CPFCliDebtd_Remet:
          description: CNPJ ou CPF Cliente Debitado ou Remetente (CNPJ_CPF, [1..1]).
          type: string
        CNPJ_CPFDestinatario:
          description: CNPJ ou CPF Destinatário (CNPJ_CPF, [0..1]).
          type: string
        CodIdentdTransf:
          description: Código Identificador Transferência (CodIdentdTransf, [0..1]).
          type: string
        CtCredtd:
          description: Conta Creditada (CtBancaria, [0..1]).
          type: string
        CtDebtd:
          description: >-
            Conta Debitada (CtBancaria, [0..1]). At most one of CtDebtd or
            CtPgtoDebtd.
          type: string
        CtPgtoDebtd:
          description: >-
            Conta Pagamento Debitada (CtPgto, [0..1]). At most one of CtDebtd or
            CtPgtoDebtd.
          type: string
        DtAgendt:
          description: Data Agendamento (xs:date, [0..1]).
          type: string
        DtMovto:
          description: Data Movimento (xs:date, [1..1]).
          type: string
        FinlddCliVarj:
          description: Finalidade Cliente Varejo (FinlddCliVarj, [1..1]).
          type: string
        Hist:
          description: Histórico (Historico, [0..1]).
          type: string
        ISPBIFCredtd:
          description: ISPB IF Creditada (ISPB, [1..1]).
          type: string
        NivelPrefPAG:
          description: Nível Preferência PAG (PrefPAG, [0..1]).
          type: string
        NomCliDebtd_Remet:
          description: Nome Cliente Debitado ou Remetente (Nome, [1..1]).
          type: string
        NomDestinatario:
          description: Nome Destinatário (Nome, [0..1]).
          type: string
        NumContrtoOpCred:
          description: Número Contrato Operação Crédito (NumContrtoOpCred, [0..1]).
          type: string
        TpCtDebtd:
          description: >-
            Tipo Conta Debitada (TpCt, [0..1]). Required when the
            Grupo_PAG0142_CtDebtd group is supplied; omit the whole group
            otherwise.
          type: string
        TpPessoaDebtd_Remet:
          description: Tipo Pessoa Debitada ou Remetente (TpPessoa, [1..1]).
          type: string
        TpPessoaDestinatario:
          description: Tipo Pessoa Destinatário (TpPessoa, [0..1]).
          type: string
        VlrLanc:
          description: Valor Lançamento (Valor, [1..1]).
          type: string
      required:
        - TpPessoaDebtd_Remet
        - CNPJ_CPFCliDebtd_Remet
        - NomCliDebtd_Remet
        - ISPBIFCredtd
        - VlrLanc
        - FinlddCliVarj
        - DtMovto
      type: object
    PagTransferBodyPAG0142Payload:
      additionalProperties: false
      properties:
        answer:
          $ref: '#/components/schemas/PAGTransferAnswerResponse'
          description: What the câmara answered; omitted until it has answered.
        answerAbsent:
          description: >-
            True only on an ANSWERED message whose answer body this rail does
            not hold. The câmara did answer; what it wrote is not here, and the
            missing answer block is that absence, never an empty answer. Omitted
            otherwise.
          type: boolean
        answeredAt:
          description: When the câmara's answer was applied; omitted until it is.
          format: date-time
          type: string
        attempts:
          description: Queue-put attempts made so far.
          format: int64
          type: integer
        codMsg:
          description: The SFN instruction code this row carries, e.g. PAG0107.
          type: string
        dispatchedAt:
          description: When the frame reached the send queue; omitted until it has.
          format: date-time
          type: string
        id:
          description: Outbound message id.
          format: uuid
          type: string
        lastError:
          description: >-
            Why the last queue put failed, or — on REFUSED — the CodErro values
            the câmara marked, verbatim. Omitted when neither applies.
          type: string
        numCtrlIF:
          description: >-
            The control number this institution issued (NumCtrlIF). The câmara
            echoes it on the answer, which is what correlates the two.
          type: string
        nuop:
          description: The BCMSG operation number of the frame.
          type: string
        request:
          $ref: '#/components/schemas/PAG0142Payload'
          description: The request exactly as it was submitted, projected verbatim.
        status:
          description: >-
            Lifecycle state. REFUSED means the câmara received the instruction
            and returned its E twin; FAILED means this rail could not deliver
            it. Both are terminal and they are different facts.
          enum:
            - SUBMITTED
            - DISPATCHED
            - ANSWERED
            - REFUSED
            - FAILED
          type: string
        submittedAt:
          description: When the instruction was recorded.
          format: date-time
          type: string
      required:
        - request
        - id
        - codMsg
        - numCtrlIF
        - nuop
        - status
        - attempts
        - submittedAt
      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
    PAGTransferAnswerResponse:
      additionalProperties: false
      properties:
        codMsg:
          description: The answer's own code, e.g. PAG0107R1.
          type: string
        movementDate:
          description: Data Movimento.
          format: date
          type: string
        numCtrlPAG:
          description: >-
            Número Controle PAG: the CÂMARA's own control number for the
            movement. A later devolução (PAG0111) names it as NumCtrlPAGOr, so
            it is the identifier needed to reverse this transfer.
          type: string
        sitLancPAG:
          description: >-
            Situação Lançamento PAG, exactly as the câmara wrote it. Its values
            are published in BACEN's separate Dicionário de Domínios (AGE, CAN,
            COM, ENF, PEC, PED, REJ), each with its own activation and
            deactivation dates, so this rail neither decodes it nor asserts a
            settlement outcome from it — read it against the dictionary version
            you hold.
          type: string
        situationAt:
          description: 'Data Hora Situação: the câmara''s clock, verbatim.'
          format: date-time
          type: string
      required:
        - codMsg
        - numCtrlPAG
        - sitLancPAG
        - situationAt
        - movementDate
      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

````