> ## 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. # Retrieve a Pix Transfer > Use this endpoint to retrieve a Pix transfer by its unique identifier. ## OpenAPI ````yaml en/openapi/v3-current/indirect-pix.yaml GET /v1/transfers/{transfer_id} openapi: 3.0.3 info: title: Plugin BR Pix Indirect - 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.7.6 servers: - url: https://plugin-pix-indirect.api.lerian.net security: - bearerAuth: [] paths: /v1/transfers/{transfer_id}: get: tags: - Transactions API summary: Retrieve a Pix Transfer description: Use this endpoint to retrieve a Pix transfer by its unique identifier. parameters: - $ref: '#/components/parameters/TransferId' - $ref: '#/components/parameters/XAccountId' responses: '200': description: Pix transfer details retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/TransferObject' '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX0001: $ref: '#/components/examples/ErrorPIX0001' ErrorPIX0008: $ref: '#/components/examples/ErrorPIX0008' ErrorPIX0404: $ref: '#/components/examples/ErrorPIX0404' '404': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX0407: $ref: '#/components/examples/ErrorPIX0407' ErrorPIX0426: $ref: '#/components/examples/ErrorPIX0426' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: ErrorPIX0000: $ref: '#/components/examples/ErrorPIX0000' deprecated: false security: - bearerAuth: [] components: parameters: TransferId: name: transfer_id in: path description: Unique identifier of the Pix transfer (UUID format). required: true example: 019c96a0-0c21-71f9-a487-66a1258278a1 schema: type: string XAccountId: name: X-Account-Id in: header description: Unique identifier of the Midaz Ledger Account (UUID format). required: true example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string schemas: TransferObject: type: object properties: id: type: string description: Transfer unique identifier. example: 019c96a0-0c21-71f9-a487-66a1258278a1 endToEndId: type: string description: End-to-end identifier. example: E123456789BR1234567890123456789 amount: type: string description: Transfer amount in BRL (format `0.00`). example: '100.00' status: type: string description: Transfer status. enum: - CREATED - PENDING - PROCESSING - COMPLETED - FAILED - REVERSED example: COMPLETED type: type: string description: Transfer type. enum: - CASHOUT - CASHIN example: CASHOUT description: type: string maxLength: 140 description: Optional description or message. example: Pix Cashout Transfer source: $ref: '#/components/schemas/TransferPartyObject' destination: $ref: '#/components/schemas/TransferPartyObject' paymentType: type: string description: Payment type. enum: - IMMEDIATE - SCHEDULED example: IMMEDIATE initiationType: type: string description: Initiation type. enum: - MANUAL - KEY - QR_CODE example: KEY urgency: type: string description: Transfer urgency. enum: - HIGH - NORMAL example: HIGH purpose: type: string description: Transaction purpose type. Defaults to TRANSFER. enum: - TRANSFER - INSTANT_PAYMENT_REFUND example: TRANSFER accountId: type: string description: Account identifier (UUID). example: 01989f9e-6508-79f8-9540-835be49fbd0d aliasId: type: string description: Alias identifier (UUID). example: 01989f9e-6508-79f8-9540-835be49fbd0e initiatedAt: type: string format: date-time description: Initiation timestamp (ISO 8601 UTC). example: '2024-01-15T10:30:00Z' createdAt: type: string format: date-time example: '2024-01-15T10:30:00Z' updatedAt: type: string format: date-time example: '2024-01-15T10:30:00Z' ledger: $ref: '#/components/schemas/LedgerInfoObject' metadata: type: object additionalProperties: true description: |- Custom key-value attributes associated with this transfer. Maximum 50 keys, key max 100 chars, value max 2000 chars. feeCharge: $ref: '#/components/schemas/FeeChargeObject' ErrorFormat: type: object description: The response message error. required: - code - title - message properties: code: type: string description: A unique, stable identifier for the error. title: type: string description: A brief summary of the issue. message: type: string description: Detailed guidance for resolving the error. TransferPartyObject: type: object description: Account party (source or destination) information. properties: key: type: string description: Pix key (if applicable). example: john.doe@example.com account: type: object description: Account details. properties: branch: type: string description: Bank branch code. example: '0001' number: type: string description: Account number. example: '123456789' participant: type: string description: ISPB of the participant institution (8 digits). example: '12345678' type: type: string description: Account type. enum: - CACC - SVGS - TRAN - OTHR example: CACC owner: type: object description: Owner details. properties: document: type: string description: Identification document (CPF 11 digits or CNPJ 14 digits). example: '12345678901' name: type: string description: Full name or registered name. example: John Doe tradeName: type: string description: Business trade name (optional). example: John's Business type: type: string enum: - NATURAL_PERSON - LEGAL_PERSON description: Owner type. example: NATURAL_PERSON LedgerInfoObject: type: object description: Midaz ledger transaction and operation identifiers. properties: transactionId: type: string description: Midaz transaction identifier (UUID). example: 550e8400-e29b-41d4-a716-446655440011 sourceOperationId: type: string description: Midaz source (DEBIT) operation identifier (UUID). example: 550e8400-e29b-41d4-a716-446655440012 destinationOperationId: type: string description: Midaz destination (CREDIT) operation identifier (UUID). example: 550e8400-e29b-41d4-a716-446655440013 revert: type: object description: >- Reversal transaction details (only present when rejected and reverted). properties: transactionId: type: string description: Midaz reversal transaction identifier (UUID). example: 550e8400-e29b-41d4-a716-446655440014 sourceOperationId: type: string description: Midaz reversal source (DEBIT) operation identifier (UUID). example: 550e8400-e29b-41d4-a716-446655440015 destinationOperationId: type: string description: Midaz reversal destination (CREDIT) operation identifier (UUID). example: 550e8400-e29b-41d4-a716-446655440016 FeeChargeObject: type: object description: Fee calculation details (if applicable). properties: applied: type: boolean description: Whether fees were applied. example: true calculationType: type: string description: Type of fee calculation. example: segment totalAmount: type: string description: Total fee amount. example: '2.50' netAmount: type: string description: Net amount after fees. example: '97.50' fees: type: array description: List of individual fees applied. items: type: object properties: feeLabel: type: string description: Label/name of the fee. example: PIX_FEE amount: type: string description: Fee amount. example: '1.50' creditAccount: type: string description: Account that receives the fee. example: 01989f9e-6508-79f8-9540-835be49fbd0d calculationType: type: string description: How the fee was calculated. example: PERCENTAGE calculationValue: type: string description: The calculation parameter (percentage or fixed value). example: '1.5' examples: ErrorPIX0001: summary: Missing Headers in Request value: code: PIX-0001 title: Missing Headers in Request message: >- Your request is missing one or more required header params. Please refer to the documentation to ensure all necessary header params are included in your request. ErrorPIX0008: summary: Invalid Path Parameter in Request value: code: PIX-0008 title: Invalid Path Parameter in Request message: >- One or more path parameters are invalid. Please refer to the documentation to verify the expected format and allowed values for each path parameter. ErrorPIX0404: summary: Invalid UUID Format value: code: PIX-0404 title: Invalid UUID Format message: The UUID format is invalid. ErrorPIX0407: summary: Transfer Account Mismatch value: code: PIX-0407 title: Transfer Account Mismatch message: The transfer does not belong to the specified account. ErrorPIX0426: summary: Transfer Not Found value: code: PIX-0426 title: Transfer Not Found message: The transfer was not found. ErrorPIX0000: summary: Internal Server Error value: code: PIX-0000 title: Internal Server Error message: The server encountered an unexpected error. Please try again later. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````