PIX Cash-Out (Pago)

Authorization: Bearer {token}
Content-Type: application/json

{
  "value": 250.50,
  "details": {
    "key": "12345678901",
    "keyType": "DOCUMENT",
    "name": "Ana Costa",
    "document": "12345678901"
  },
  "externalId": "PAYMENT-987654-20240119",
  "description": "Pago a proveedor"
}

curl -X POST https://api.fypay.me/api/pix/cash-out \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "value": 250.50,
    "details": {
      "key": "12345678901",
      "keyType": "DOCUMENT",
      "name": "Ana Costa",
      "document": "12345678901"
    },
    "externalId": "PAYMENT-987654-20240119",
    "description": "Pago a proveedor"
  }'

{
  "transactionId": "9876",
  "externalId": "PAYMENT-987654-20240119",
  "status": "PENDING",
  "generateTime": "2024-01-19T15:45:00.000Z"
}

import axios from 'axios';

interface CashOutRequest {
  value: number;
  details: {
    key: string;
    keyType: 'DOCUMENT' | 'EMAIL' | 'PHONE' | 'RANDOM';
    name: string;
    document: string;
  };
  externalId: string;
  description?: string;
}

interface CashOutResponse {
  transactionId: string;
  externalId: string;
  status: 'PENDING' | 'CONFIRMED' | 'ERROR';
  generateTime: string;
}

async function sendPixPayment(
  token: string,
  recipientKey: string,
  recipientKeyType: 'DOCUMENT' | 'EMAIL' | 'PHONE' | 'RANDOM',
  recipientName: string,
  recipientDocument: string,
  amount: number,
  description?: string
): Promise<CashOutResponse> {
  const payload: CashOutRequest = {
    value: amount,
    details: {
      key: recipientKey,
      keyType: recipientKeyType,
      name: recipientName,
      document: recipientDocument
    },
    externalId: `PAY-${Date.now()}-${Math.random().toString(36).substr(2, 9)}`,
    description: description || `Pago PIX de R$ ${amount.toFixed(2)}`
  };

  try {
    const response = await axios.post<CashOutResponse>(
      'https://api.fypay.me/api/pix/cash-out',
      payload,
      {
        headers: {
          'Authorization': `Bearer ${token}`,
          'Content-Type': 'application/json'
        }
      }
    );

    console.log('¡Pago PIX iniciado con éxito!');
    console.log(`ID de la Transacción: ${response.data.transactionId}`);
    console.log(`Estado: ${response.data.status}`);
    console.log(`Valor: R$ ${amount.toFixed(2)}`);
    console.log(`Destinatario: ${recipientName}`);

    return response.data;
  } catch (error) {
    if (axios.isAxiosError(error)) {
      const errorData = error.response?.data;
      console.error('Error al realizar el pago:', errorData);

      // Tratar errores específicos
      if (error.response?.status === 400) {
        if (errorData?.code === 'PIX_INSUFFICIENT_BALANCE') {
          throw new Error('Saldo insuficiente para realizar el pago');
        }
        throw new Error('Datos inválidos: ' + errorData?.message);
      }

      if (error.response?.status === 422 || error.response?.status === 429) {
        // Protecciones del retiro por clave: vea /es/docs/guides/pix-cash-out-protections
        const retryAfter = error.response.headers['retry-after'];
        throw new Error(`${errorData?.code}: intente de nuevo en ${retryAfter ?? '?'} s`);
      }

      throw new Error(errorData?.message || 'Error al realizar el pago PIX');
    }
    throw error;
  }
}

// Uso - Pago por CPF
sendPixPayment(
  'su_token_aqui',
  '12345678901',
  'DOCUMENT',
  'Ana Costa',
  '12345678901',
  250.50,
  'Pago a proveedor'
);

// Uso - Pago por Email
sendPixPayment(
  'su_token_aqui',
  'ana.costa@email.com',
  'EMAIL',
  'Ana Costa',
  '12345678901',
  100.00,
  'Reembolso'
);

// Uso - Pago por Teléfono (DDD + número, sin código de país +55)
sendPixPayment(
  'su_token_aqui',
  '11999999999',
  'PHONE',
  'Ana Costa',
  '12345678901',
  50.00
);

import requests
from datetime import datetime
from typing import Dict, Optional
import uuid

def send_pix_payment(
    token: str,
    recipient_key: str,
    recipient_key_type: str,
    recipient_name: str,
    recipient_document: str,
    amount: float,
    description: Optional[str] = None
) -> Dict:
    """
    Envía un pago PIX

    Args:
        token: Token Bearer válido
        recipient_key: Clave PIX del destinatario
        recipient_key_type: Tipo de clave (DOCUMENT, EMAIL, PHONE, RANDOM)
        recipient_name: Nombre del destinatario
        recipient_document: CPF o CNPJ del destinatario
        amount: Valor en reales
        description: Descripción del pago (opcional)

    Returns:
        Datos del pago iniciado
    """
    url = 'https://api.fypay.me/api/pix/cash-out'

    payload = {
        'value': round(amount, 2),
        'details': {
            'key': recipient_key,
            'keyType': recipient_key_type,
            'name': recipient_name,
            'document': recipient_document
        },
        'externalId': f'PAY-{int(datetime.now().timestamp())}-{uuid.uuid4().hex[:8]}',
        'description': description or f'Pago PIX de R$ {amount:.2f}'
    }

    headers = {
        'Authorization': f'Bearer {token}',
        'Content-Type': 'application/json'
    }

    try:
        response = requests.post(url, json=payload, headers=headers)
        response.raise_for_status()

        data = response.json()

        print('¡Pago PIX iniciado con éxito!')
        print(f"ID de la Transacción: {data['transactionId']}")
        print(f"Estado: {data['status']}")
        print(f"Valor: R$ {amount:.2f}")
        print(f"Destinatario: {recipient_name}")

        return data

    except requests.exceptions.HTTPError as e:
        error_data = e.response.json() if e.response else {}

        # Tratar errores específicos
        if e.response.status_code == 400:
            if error_data.get('code') == 'PIX_INSUFFICIENT_BALANCE':
                raise Exception('Saldo insuficiente para realizar el pago')
            raise Exception(f"Datos inválidos: {error_data.get('message')}")

        raise Exception(f"Error al realizar el pago: {error_data.get('message', str(e))}")

# Uso
token = 'su_token_aqui'

# Pago por CPF
payment = send_pix_payment(
    token=token,
    recipient_key='12345678901',
    recipient_key_type='DOCUMENT',
    recipient_name='Ana Costa',
    recipient_document='12345678901',
    amount=250.50,
    description='Pago a proveedor'
)

<?php

function sendPixPayment(
    string $token,
    string $recipientKey,
    string $recipientKeyType,
    string $recipientName,
    string $recipientDocument,
    float $amount,
    ?string $description = null
): array {
    $url = 'https://api.fypay.me/api/pix/cash-out';

    $payload = [
        'value' => round($amount, 2),
        'details' => [
            'key' => $recipientKey,
            'keyType' => $recipientKeyType,
            'name' => $recipientName,
            'document' => $recipientDocument
        ],
        'externalId' => 'PAY-' . time() . '-' . bin2hex(random_bytes(4)),
        'description' => $description ?? "Pago PIX de R$ " . number_format($amount, 2, ',', '.')
    ];

    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json'
    ]);

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($httpCode !== 201) {
        $errorData = json_decode($response, true);
        $errorMessage = $errorData['message'] ?? "HTTP $httpCode";

        if ($httpCode === 400 && ($errorData['code'] ?? '') === 'PIX_INSUFFICIENT_BALANCE') {
            throw new Exception('Saldo insuficiente para realizar el pago');
        }

        throw new Exception("Error al realizar el pago: $errorMessage");
    }

    $data = json_decode($response, true);

    echo "¡Pago PIX iniciado con éxito!" . PHP_EOL;
    echo "ID de la Transacción: {$data['transactionId']}" . PHP_EOL;
    echo "Estado: {$data['status']}" . PHP_EOL;
    echo "Valor: R$ " . number_format($amount, 2, ',', '.') . PHP_EOL;
    echo "Destinatario: $recipientName" . PHP_EOL;

    return $data;
}

// Uso
$token = 'su_token_aqui';
$payment = sendPixPayment(
    $token,
    '12345678901',
    'DOCUMENT',
    'Ana Costa',
    '12345678901',
    250.50,
    'Pago a proveedor'
);

class PayrollProcessor {
  constructor(private token: string) {}

  async processPayroll(employees: Employee[]) {
    const results = {
      successful: [],
      failed: []
    };

    for (const employee of employees) {
      try {
        // Verificar el saldo antes de cada pago
        const balance = await getBalance(this.token);

        if (balance.netBalance < employee.salary) {
          throw new Error('Saldo insuficiente');
        }

        // Realizar el pago
        const payment = await sendPixPayment(
          this.token,
          employee.pixKey,
          employee.pixKeyType,
          employee.fullName,
          employee.document,
          employee.salary,
          `Salario ${new Date().toLocaleDateString('es', { month: 'long', year: 'numeric' })}`
        );

        results.successful.push({
          employee: employee.fullName,
          amount: employee.salary,
          transactionId: payment.transactionId
        });

        // Esperar 1 segundo entre pagos
        await this.sleep(1000);

      } catch (error) {
        results.failed.push({
          employee: employee.fullName,
          error: error.message
        });
      }
    }

    return results;
  }

  private sleep(ms: number): Promise<void> {
    return new Promise(resolve => setTimeout(resolve, ms));
  }
}

// Uso
interface Employee {
  fullName: string;
  document: string;
  pixKey: string;
  pixKeyType: 'DOCUMENT' | 'EMAIL' | 'PHONE' | 'RANDOM';
  salary: number;
}

const payroll = new PayrollProcessor('su_token_aqui');
const employees: Employee[] = [
  {
    fullName: 'Pedro Santos',
    document: '12345678901',
    pixKey: '12345678901',
    pixKeyType: 'DOCUMENT',
    salary: 3500.00
  },
  // ... más empleados
];

const results = await payroll.processPayroll(employees);
console.log(`Pagos exitosos: ${results.successful.length}`);
console.log(`Pagos con error: ${results.failed.length}`);

class MarketplacePayouts:
    """Procesa transferencias a vendedores del marketplace"""

    def __init__(self, token: str):
        self.token = token

    def process_seller_payouts(self, sales_data: list) -> dict:
        """Procesa transferencias basadas en ventas"""
        results = {'successful': [], 'failed': []}

        # Agrupar ventas por vendedor
        seller_totals = self.group_sales_by_seller(sales_data)

        for seller_id, total_amount in seller_totals.items():
            try:
                # Buscar datos del vendedor
                seller = self.get_seller_data(seller_id)

                # Calcular el valor después de la comisión
                commission = total_amount * 0.10  # 10% de comisión
                payout_amount = total_amount - commission

                # Realizar el pago
                payment = send_pix_payment(
                    token=self.token,
                    recipient_key=seller['pix_key'],
                    recipient_key_type=seller['pix_key_type'],
                    recipient_name=seller['name'],
                    recipient_document=seller['document'],
                    amount=payout_amount,
                    description=f'Transferencia de ventas - {len(sales_data)} transacciones'
                )

                results['successful'].append({
                    'seller': seller['name'],
                    'gross_amount': total_amount,
                    'commission': commission,
                    'net_amount': payout_amount,
                    'transaction_id': payment['transactionId']
                })

                # Registrar la transferencia en la base de datos
                self.record_payout(seller_id, payment)

            except Exception as e:
                results['failed'].append({
                    'seller_id': seller_id,
                    'error': str(e)
                })

        return results

    def group_sales_by_seller(self, sales_data: list) -> dict:
        """Agrupa ventas por vendedor"""
        totals = {}
        for sale in sales_data:
            seller_id = sale['seller_id']
            totals[seller_id] = totals.get(seller_id, 0) + sale['amount']
        return totals

class RefundSystem {
  constructor(token) {
    this.token = token;
  }

  async processRefund(orderId, refundReason) {
    // Buscar datos del pedido
    const order = await this.getOrderData(orderId);

    // Validar si el reembolso está permitido
    if (!this.canRefund(order)) {
      throw new Error('Reembolso no permitido para este pedido');
    }

    // Realizar el pago de vuelta al cliente
    const refund = await sendPixPayment(
      this.token,
      order.customer.pixKey,
      order.customer.pixKeyType,
      order.customer.name,
      order.customer.document,
      order.amount,
      `Reembolso - Pedido ${orderId} - ${refundReason}`
    );

    // Actualizar el estado del pedido
    await this.updateOrderStatus(orderId, 'REFUNDED', refund.transactionId);

    // Enviar notificación al cliente
    await this.notifyCustomer(order.customer.email, refund);

    return refund;
  }

  canRefund(order) {
    // Verificar si el pedido fue pagado y aún está dentro del plazo
    const daysSincePurchase = (Date.now() - new Date(order.paidAt)) / (1000 * 60 * 60 * 24);
    return order.status === 'PAID' && daysSincePurchase <= 7;
  }
}

function inferPixKeyType(key: string): 'DOCUMENT' | 'EMAIL' | 'PHONE' | 'RANDOM' | null {
  const trimmed = key.trim();

  // 1. UUID (clave aleatoria / EVP)
  const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
  if (uuidRegex.test(trimmed)) return 'RANDOM';

  // 2. Email
  if (trimmed.includes('@')) return 'EMAIL';

  // 3. Solo dígitos → DOCUMENT o PHONE
  const digits = trimmed.replace(/\D/g, '');

  // 14 dígitos → CNPJ
  if (digits.length === 14) return 'DOCUMENT';

  // 11 dígitos → CPF o PHONE
  // La distinción se hace validando los dígitos verificadores del CPF
  if (digits.length === 11) {
    return isValidCpf(digits) ? 'DOCUMENT' : 'PHONE';
  }

  // 10 dígitos → teléfono fijo (DDD + 8 dígitos)
  if (digits.length === 10) return 'PHONE';

  return null; // Formato no reconocido
}

// Validación algorítmica de CPF (dígitos verificadores)
function isValidCpf(cpf: string): boolean {
  if (/^(\d)\1{10}$/.test(cpf)) return false; // Rechaza secuencias como 11111111111
  let sum = 0;
  for (let i = 0; i < 9; i++) sum += parseInt(cpf[i]) * (10 - i);
  let check = 11 - (sum % 11);
  if (check >= 10) check = 0;
  if (check !== parseInt(cpf[9])) return false;
  sum = 0;
  for (let i = 0; i < 10; i++) sum += parseInt(cpf[i]) * (11 - i);
  check = 11 - (sum % 11);
  if (check >= 10) check = 0;
  return check === parseInt(cpf[10]);
}

function validatePixKey(key: string, keyType: string): boolean {
  switch (keyType) {
    case 'DOCUMENT':
      // CPF: 11 dígitos o CNPJ: 14 dígitos (solo números)
      return /^\d{11}$/.test(key) || /^\d{14}$/.test(key);

    case 'EMAIL':
      // Email con dominio válido (TLD mínimo de 2 caracteres)
      return /^[^\s@]+@[^\s@]+\.[^\s@]{2,}$/.test(key);

    case 'PHONE':
      // DDD + número: 10 dígitos (fijo) u 11 dígitos (celular)
      // NO incluya el código de país (+55) — la API lo agrega automáticamente
      return /^\d{10,11}$/.test(key);

    case 'RANDOM':
      // UUID con guiones o 32 caracteres hexadecimales sin guiones
      return /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/.test(key)
        || /^[a-fA-F0-9]{32}$/.test(key);

    default:
      return false;
  }
}

async function safePayment(
  token: string,
  amount: number,
  recipient: RecipientData
) {
  // Consultar el saldo
  const balance = await getBalance(token);

  // Verificar si hay saldo suficiente
  if (balance.netBalance < amount) {
    throw new Error(
      `Saldo insuficiente. Disponible: R$ ${balance.netBalance.toFixed(2)} | ` +
      `Necesario: R$ ${amount.toFixed(2)}`
    );
  }

  // Continuar con el pago
  return await sendPixPayment(token, ...recipient, amount);
}

async function monitorPaymentStatus(transactionId, timeout = 60000) {
  const startTime = Date.now();

  while (Date.now() - startTime < timeout) {
    const status = await checkTransactionStatus(transactionId);

    if (status === 'CONFIRMED') {
      console.log('¡Pago confirmado!');
      return true;
    }

    if (status === 'ERROR') {
      throw new Error('El pago falló');
    }

    // Esperar 2 segundos antes de verificar de nuevo
    await new Promise(resolve => setTimeout(resolve, 2000));
  }

  throw new Error('Timeout: Pago no confirmado en el tiempo esperado');
}

POST /api/pix/cash-out
         │
         ▼
     ┌─────────┐
     │ PENDING  │  ← Respuesta inmediata de la API (201)
     └────┬─────┘
          │  (procesamiento en el banco liquidador)
          │
    ┌─────┴──────┐
    ▼            ▼
┌──────────┐ ┌───────┐
│CONFIRMED │ │ ERROR │  ← Notificado vía webhook
└──────────┘ └───────┘

{
  "event": "CashOut",
  "status": "ERROR",
  "transactionId": "12345",
  "externalId": "PAYMENT-987654-20240119",
  "errorCode": "TAX_ID_MISMATCH",
  "errorMessage": "O CPF/CNPJ informado não corresponde ao titular da conta.",
  ...
}