Obtener Solicitud de Pago

Obtiene los detalles completos de una Solicitud de Pago específica.

Endpoint

GET /v1/payment-links/{id}

Autenticación

Requiere API Key con el ability payment_links:read.

Parámetros de Ruta

Parámetro	Tipo	Requerido	Descripción
`id`	string (UUID)	Sí	ID de la Solicitud de Pago

Ejemplo de Solicitud

curl -X GET "https://api.alohapay.co/api/external/v1/payment-links/9d8f7a6b-5c4d-3e2f-1a0b-9c8d7e6f5a4b" \
  -H "X-API-KEY: tu_api_key_aqui"

const paymentLinkId = '9d8f7a6b-5c4d-3e2f-1a0b-9c8d7e6f5a4b';

const response = await fetch(
  `https://api.alohapay.co/api/external/v1/payment-links/${paymentLinkId}`,
  {
    headers: {
      'X-API-KEY': 'tu_api_key_aqui'
    }
  }
);
const data = await response.json();

console.log('Status:', data.data.status);

import requests

payment_link_id = '9d8f7a6b-5c4d-3e2f-1a0b-9c8d7e6f5a4b'

headers = {
    'X-API-KEY': 'tu_api_key_aqui'
}

response = requests.get(
    f'https://api.alohapay.co/api/external/v1/payment-links/{payment_link_id}',
    headers=headers
)
data = response.json()

print('Status:', data['data']['status'])

<?php
$paymentLinkId = '9d8f7a6b-5c4d-3e2f-1a0b-9c8d7e6f5a4b';

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.alohapay.co/api/external/v1/payment-links/{$paymentLinkId}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-API-KEY: tu_api_key_aqui'
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

echo 'Status: ' . $data['data']['status'];

Respuesta Exitosa (200 OK)

{
  "success": true,
  "message": "Payment link retrieved successfully",
  "data": {
    "amount": 100.00,
    "currency": "USD",
    "currency_destiny": "USD",
    "description": "Factura #1234 - Suscripción mensual",
    "expires_at": "2025-12-10T10:30:00.000000Z",
    "max_uses": 1,
    "current_uses": 0,
    "status": "active",
    "checkout_url": "https://checkout.alohapay.co/s/9d8f7a6b-5c4d-3e2f-1a0b-9c8d7e6f5a4b",
    "payment_method": "card",
    "created_at": "2025-12-03T10:30:00.000000Z",
    "updated_at": "2025-12-03T10:30:00.000000Z"
  }
}

Campos de Respuesta

Campo	Tipo	Descripción
`amount`	number	Monto del pago
`currency`	string	Moneda del cliente
`currency_destiny`	string	Moneda del wallet (destino de fondos)
`description`	string	Descripción del pago
`expires_at`	string/null	Fecha de expiración (ISO 8601) o null si no expira
`max_uses`	integer/null	Número máximo de usos o null para ilimitado
`current_uses`	integer	Número de veces que se ha usado el enlace
`status`	string	Estado: `active`, `completed`, `cancelled`, `expired`
`checkout_url`	string	URL para que los clientes realicen el pago
`payment_method`	string	Tipo de método de pago
`created_at`	string	Fecha de creación (ISO 8601)
`updated_at`	string	Última actualización (ISO 8601)

Errores Posibles

Solicitud de Pago No Encontrada (404)

{
  "success": false,
  "code": "PAYMENT_LINK_NOT_FOUND",
  "message": "Payment link not found"
}

Usuario No Encontrado (404)

{
  "success": false,
  "code": "USER_NOT_FOUND",
  "message": "User associated with API key not found"
}

Tabla de Errores

Código HTTP	Código de Error	Descripción
401	`invalid_api_key`	API Key inválida o expirada
403	`insufficient_scope`	La API Key no tiene el ability `payment_links:read`
404	`PAYMENT_LINK_NOT_FOUND`	Solicitud de Pago no encontrada o no pertenece al usuario
404	`USER_NOT_FOUND`	Usuario asociado a la API Key no encontrado