> ## Documentation Index > Fetch the complete documentation index at: https://docs.y.uno/llms.txt > Use this file to discover all available pages before exploring further. # Create Payout ## OpenAPI ````yaml openapi/yuno_sandbox_tested.json POST /v1/payouts openapi: 3.1.0 info: title: Yuno Payments API version: 1.0.0 description: > The Yuno Payments API is built around REST principles, using standard HTTP methods and JSON payloads. ## Authentication All requests require two headers: ``` public-api-key: YOUR_PUBLIC_KEY private-secret-key: YOUR_PRIVATE_KEY ``` ## Idempotency Payment mutations (create, capture, cancel, refund, payout) require an `X-Idempotency-Key` header (UUID). The API stores the key and returns the same response for duplicate requests within 24 hours. ## Environments | Environment | Base URL | |-------------|----------| | Sandbox | `https://api-sandbox.y.uno/v1` | | Production | `https://api.y.uno/v1` | contact: name: Yuno Support url: https://docs.y.uno license: name: Proprietary servers: - url: https://api-sandbox.y.uno description: Sandbox - url: https://api.y.uno description: Production (US) - url: https://api.eu.y.uno description: Production (EMEA) security: - PublicApiKey: [] PrivateSecretKey: [] tags: - name: Customers description: Create and manage customer records. - name: Checkout Sessions description: Initialize the Yuno SDK on the front-end. - name: Payment Methods description: Enroll and manage vaulted payment methods. - name: Payments description: Create and manage payment transactions. - name: Payment Links description: Hosted payment pages requiring no SDK. - name: Subscriptions description: Recurring billing management. - name: Payouts description: Disburse funds to individuals or entities. - name: Reports description: Generate and download transaction reports. - name: Currency Conversion description: Dynamic currency conversion (DCC). paths: /v1/payouts: post: tags: - Payouts summary: Create Payout operationId: create-payout parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePayoutRequest' examples: card_payout: summary: Card payout (US) value: account_id: YOUR_ACCOUNT_ID merchant_reference: payout-001 country: US purpose: PROVIDER_SERVICES amount: currency: USD value: 10000 beneficiary: merchant_beneficiary_id: beneficiary-001 national_entity: INDIVIDUAL first_name: Jane last_name: Smith email: jane.smith@example.com country: US document: document_type: DNI document_number: '987654321' withdrawal_method: type: CARD provider_id: UNLIMINT pix_payout: summary: PIX payout (Brazil) value: account_id: YOUR_ACCOUNT_ID merchant_reference: pix-001 country: BR purpose: REMITTANCES amount: currency: BRL value: 10000 beneficiary: merchant_beneficiary_id: br-beneficiary-001 national_entity: INDIVIDUAL first_name: Carlos last_name: Silva email: carlos.silva@example.com country: BR document: document_type: CPF document_number: '12345678901' withdrawal_method: type: PIX_PAYOUT responses: '201': description: Payout created content: application/json: schema: $ref: '#/components/schemas/Payout' components: parameters: IdempotencyKey: name: X-Idempotency-Key in: header required: true schema: type: string format: uuid description: Unique UUID per request. Prevents duplicate processing on retries. schemas: CreatePayoutRequest: type: object required: - account_id - merchant_reference - country - purpose - amount - beneficiary - withdrawal_method properties: account_id: type: string format: uuid merchant_reference: type: string minLength: 3 maxLength: 255 description: type: string country: $ref: '#/components/schemas/Country' purpose: type: string enum: - FAMILY_AND_FRIENDS - PERSONAL_TRANSFER - REMITTANCES - PROVIDER_SERVICES - EXPENSES - REFUND - SALARY - PENSION - LOAN - DIVIDENDS amount: $ref: '#/components/schemas/Amount' beneficiary: $ref: '#/components/schemas/Beneficiary' withdrawal_method: type: object required: - type properties: type: type: string enum: - CARD - PIX_PAYOUT - PAYPAL_PAYOUT - NEQUI_PAYOUT - ASTROPAY_PAYOUT - STP_PAYOUT - TRANSFIYA_PAYOUT - UNLIMINT_PAYOUT - QI_PAYOUT provider_id: type: string enum: - ASTROPAY - NEQUI - PAYPAL - UNLIMINT Payout: type: object properties: id: type: string format: uuid merchant_reference: type: string status: type: string enum: - SUCCEEDED - PENDING - DECLINED - PROCESSING amount: $ref: '#/components/schemas/Amount' created_at: type: string format: date-time Country: type: string enum: - AR - BO - BR - CL - CO - CR - EC - SV - GT - HN - MX - NI - PA - PY - PE - US - UY description: ISO 3166-1 alpha-2 country code Amount: type: object required: - currency - value properties: currency: $ref: '#/components/schemas/Currency' value: type: number multipleOf: 0.0001 description: Amount in cents (e.g. 10000 = $100.00) Beneficiary: type: object required: - merchant_beneficiary_id - country properties: merchant_beneficiary_id: type: string national_entity: type: string enum: - INDIVIDUAL - ENTITY first_name: type: string maxLength: 80 last_name: type: string maxLength: 80 legal_name: type: string maxLength: 80 description: Required when national_entity is ENTITY email: type: string format: email country: $ref: '#/components/schemas/Country' date_of_birth: type: string pattern: ^\d{4}-\d{2}-\d{2}$ document: $ref: '#/components/schemas/Document' phone: $ref: '#/components/schemas/Phone' address: $ref: '#/components/schemas/Address' Currency: type: string minLength: 3 maxLength: 3 description: ISO 4217 currency code (e.g. USD, BRL, MXN) Document: type: object properties: document_type: type: string enum: - DNI - CI - LC - LE - CUIT - CUIL - PAS - CPF - RG - CNH - CNPJ - RUT - RUN - CC - CE - NIT - DUI - PIC - DPI - IFR - INE - CP - RFC - CURP - CIP - CIC - CUI - RUC document_number: type: string minLength: 3 maxLength: 40 Phone: type: object properties: country_code: type: string example: '+1' number: type: string example: '5550000001' Address: type: object properties: address_line_1: type: string address_line_2: type: string city: type: string state: type: string zip_code: type: string country: $ref: '#/components/schemas/Country' neighborhood: type: string ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.