Crear Payment Request
Crea una nueva solicitud de pago. Una vez creada, el cliente podrá realizar el pago a través de los métodos de pago disponibles.
Endpoint
Section titled “Endpoint”POST /api/v1/payment_requests
Parámetros
Section titled “Parámetros” amount (float) requerido
Monto a cobrar en la moneda principal (USD).
description (string) requerido
Descripción de la solicitud de pago.
external_id (string)
Identificador externo definido por el usuario para referenciar esta solicitud.
customer (object) requerido
Información del cliente que realizará el pago.
dni (string) requerido
Número de identificación del cliente.
email (string)
Correo electrónico del cliente. Opcional si el dni ya está registrado. Requerido en caso contrario.
first_name (string)
Nombre del cliente. Opcional si el dni ya está registrado. Requerido en caso contrario.
last_name (string)
Apellido del cliente. Opcional si el dni ya está registrado. Requerido en caso contrario.
Respuesta
Section titled “Respuesta”Retorna el objeto Payment Request creado.
Códigos de estado
Section titled “Códigos de estado”201 Created
- La solicitud se creó exitosamente400 Bad Request
- Error en los parámetros enviados401 Unauthorized
- Error de autenticación422 Unprocessable Entity
- Error de validación
Ejemplo de solicitud
Section titled “Ejemplo de solicitud”curl -X POST https://api.vesvank.com/api/v1/payment_requests \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amount": 10, "description": "Test 10 dollars from API", "external_id": "order_0001", "customer": { "dni": "V1000000", "email": "example@vesvank.com", "first_name": "John", "last_name": "Doe" } }'
Ejemplo de respuesta
Section titled “Ejemplo de respuesta”{ "id": "preq_1234567890", "description": "My first payment request", "external_id": "order_0001", "token": "PR123456", "status": "waiting_for_payment", "created_at": 1747510755, "updated_at": 1747510755, "main_amount": { "amount_cents": 1000, "amount": 10.0, "currency_iso": "USD" }, "conversion_amount": { "amount_cents": 90500, "amount": 950.0, "currency_iso": "VES" }, "customer": { "id": "cus_ABCDEFGH", "dni": "V1000000", "email": "example@vesvank.com" }, "rate": { "amount_cents": 9050, "amount": 90.5, "currency_iso": "VES" }, "succeeded_payment_intent": null, "pending_payment_intents": [], "rejected_payment_intents": [], "payment_url": "https://subdomain.vesvank.com/payments_portal/payment_requests/PR123456"}