Cancelar Solicitud de Pago

Cancela una Solicitud de Pago que está actualmente activa. El enlace debe estar en estado active y no haber sido usado.

Endpoint

DELETE /v1/payment-links/{id}

Autenticación

Requiere API Key con el ability payment_links:cancel.

Parámetros de Ruta

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

Ejemplo de Solicitud

cURL

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

JavaScript

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

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

if (data.success) {
  console.log('Solicitud de pago cancelada exitosamente');
}

Python

import requests

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

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

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

if data['success']:
    print('Solicitud de pago cancelada exitosamente')

PHP

<?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_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'X-API-KEY: tu_api_key_aqui'
    ]
]);

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

if ($data['success']) {
    echo 'Solicitud de pago cancelada exitosamente';
}

Respuesta Exitosa (200 OK)

{
  "success": true,
  "message": "Payment link cancelled successfully"
}

Errores Posibles

Solicitud de Pago No Encontrada (404)

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

Solicitud de Pago No Activa (422)

{
  "success": false,
  "code": "PAYMENT_LINK_NOT_ACTIVE",
  "message": "Payment link cannot be cancelled because it is not active",
  "errors": {
    "status": "Current status is 'completed'"
  }
}

Solicitud de Pago Ya Usada (422)

{
  "success": false,
  "code": "PAYMENT_LINK_CANNOT_CANCEL",
  "message": "Payment link cannot be cancelled because it has already been used",
  "errors": {
    "current_uses": 1
  }
}

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:cancel
404	PAYMENT_LINK_NOT_FOUND	Solicitud de Pago no encontrada
422	PAYMENT_LINK_NOT_ACTIVE	La Solicitud de Pago no está en estado activo
422	PAYMENT_LINK_CANNOT_CANCEL	La Solicitud de Pago ya fue usada

Condiciones para Cancelar

Para cancelar una Solicitud de Pago se deben cumplir ambas condiciones:

1. El estado debe ser active
2. El campo current_uses debe ser 0

Irreversible

Una vez cancelada, una Solicitud de Pago no puede ser reactivada. Deberás crear una nueva si necesitas recibir el pago.

Cuándo Cancelar una Solicitud de Pago

Considera cancelar una Solicitud de Pago cuando:

• El cliente ya no necesita realizar el pago
• Se creó por error
• Deseas actualizar el monto (cancela y crea uno nuevo)
• Ha pasado mucho tiempo y el cliente no ha pagado