> ## Documentation Index
> Fetch the complete documentation index at: https://yn-c9bb3266.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Payout by Merchant Reference

> Retrieves a payout using the merchant's external reference identifier.

<Note>
  This endpoint may require UUID format for the reference parameter. Verify the correct format for your use case.
</Note>


## OpenAPI

````yaml GET /v1/payouts/merchant-ref/{merchant_reference}
openapi: 3.1.0
info:
  title: Yuno Payments API
  description: >-
    Yuno payment orchestration platform — unified REST API for payments,
    checkout sessions, customers, payment methods, subscriptions, payouts,
    marketplace transfers, and banking connectivity across Latin America.
  version: 1.0.0
  contact:
    name: Yuno Support
    email: support@y.uno
    url: https://docs.y.uno
  license:
    name: Proprietary
    url: https://y.uno
servers:
  - url: https://api-sandbox.y.uno
    description: Sandbox
  - url: https://api.y.uno
    description: Production
security:
  - publicApiKey: []
    privateSecretKey: []
paths:
  /v1/payouts/merchant-ref/{merchant_reference}:
    get:
      tags:
        - Payouts
      summary: Get payout by merchant reference
      description: Retrieves a payout using the merchant's external reference identifier.
      operationId: getPayoutByMerchantReference
      parameters:
        - name: merchant_reference
          in: path
          required: true
          description: The merchant-assigned payout reference
          schema:
            type: string
          example: payout-ref-001
      responses:
        '200':
          description: Payout details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payout'
        '404':
          description: Payout not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Payout:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: e2f3a4b5-c6d7-8e9f-0a1b-2c3d4e5f6a7b
        status:
          type: string
          enum:
            - SUCCEEDED
            - PENDING
            - FAILED
            - CANCELLED
          description: Current payout status
          example: PENDING
        amount:
          $ref: '#/components/schemas/Amount'
        country:
          type: string
          example: BR
        recipient_id:
          type: string
          format: uuid
          example: d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a
        merchant_reference:
          type: string
          example: payout-ref-001
        created_at:
          type: string
          format: date-time
          example: '2026-03-01T16:00:00.000Z'
      example:
        id: e2f3a4b5-c6d7-8e9f-0a1b-2c3d4e5f6a7b
        status: PENDING
        amount:
          currency: BRL
          value: 500
        country: BR
        recipient_id: d1e2f3a4-b5c6-7d8e-9f0a-1b2c3d4e5f6a
        merchant_reference: payout-ref-001
        created_at: '2026-03-01T16:00:00.000Z'
    Error:
      type: object
      description: >-
        Standard error envelope returned by every Yuno service for any 4xx or
        5xx response. Top level. `code` is a stable SCREAMING_SNAKE_CASE
        identifier. `messages` is always an array of strings, even when there is
        only one entry. There is no `error` wrapper, no singular `message`, no
        `type`, no `details`. See the Error handling guide for the full code
        catalog.
      required:
        - code
        - messages
      properties:
        code:
          type: string
          description: >-
            Stable, machine readable identifier. Branch on this in your client.
            Common values include `BAD_REQUEST`, `VALIDATION_ERROR`,
            `INVALID_REQUEST`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`,
            `TOO_MANY_REQUESTS`, `INTERNAL_ERROR`, `BAD_GATEWAY`,
            `SERVICE_UNAVAILABLE`, plus business codes like
            `CUSTOMER_ID_DUPLICATED`, `RECIPIENT_NOT_FOUND`, `INVALID_STATE`,
            and the `PROVIDER_*` family for downstream provider errors.
          example: VALIDATION_ERROR
        messages:
          type: array
          description: >-
            Human readable details. Validation errors put one entry per failed
            field, formatted `"fieldName message"`.
          items:
            type: string
          example:
            - merchant_customer_id must not be blank
      example:
        code: VALIDATION_ERROR
        messages:
          - amount must be greater than 0
          - country must not be blank
    Amount:
      type: object
      required:
        - currency
        - value
      properties:
        currency:
          type: string
          description: ISO 4217 currency code
          example: BRL
        value:
          type: number
          description: >-
            Payment amount in major currency units (e.g., 150.00 means 150 BRL,
            not cents). For zero-decimal currencies like CLP and PYG, use whole
            numbers (e.g., 15000 means 15,000 CLP).
          example: 100
      example:
        currency: BRL
        value: 100
  securitySchemes:
    publicApiKey:
      type: apiKey
      in: header
      name: public-api-key
      description: Your public API key from the Yuno Dashboard
    privateSecretKey:
      type: apiKey
      in: header
      name: private-secret-key
      description: Your private secret key (server-side only)

````