Skip to main content

OpenAPI spec

Ver el archivo OpenAPI de esta documentación

Authentication

Todos los endpoints requieren una API key enviada en el header:

Base URLs

  • Production: https://api.prod.payana.cloud/public/api/v1
  • Develop: https://api.develop.payana.cloud/public/api/v1

Rate Limits

  • 1000 requests per hour per API key
  • 100 requests per minute (burst)

Webhooks

Configura endpoints para recibir notificaciones en tiempo real cuando se procesan pagos o cambian estados.

Webhook Headers

  • Content-Type: application/json
  • X-Payana-Signature: HMAC SHA256 del body
  • X-Payana-Event: Tipo de evento (ej. payment.out.transaction.success)
  • X-Payana-Timestamp: Timestamp ISO 8601

Signature Verification

Para verificar la firma, calcula el HMAC SHA256 del request body usando el webhook secret:

Error Responses

Formato de error:

Common Error Codes

  • VALIDATION_ERROR (400)
  • UNAUTHORIZED (401)
  • FORBIDDEN (403)
  • NOT_FOUND (404)
  • CONFLICT (409)
  • RATE_LIMITED (429)
  • INTERNAL_ERROR (500)

Status Codes

Payable Status Values

  • pending
  • scheduled
  • processing
  • paid
  • failed
  • refunded