Checkout | VanaPay
Crea una instancia de un link de pago, proporcionando un objeto de tipo Checkout Request.
Esta pasarela de pago solo soporta un formulario de pago Alojado, esto quiere decir que VanaPay se hará cargo de toda la lógica del pago dentro de sus servidores.
Autenticación
Para poder autenticarse con el API de vanapay debes de proveer el token obtenido en la llamada de setup.
Payload
A continuación, puedes encontrar un ejemplo del cuerpo de esta llamada. Debajo podrás encontrar una tabla describiendo cada parámetro del cuerpo de la llamada.
Copiado!
{
"number": 23,
"description": "Prueba de Orden",
"amount": 150.5,
"currency": "GTQ",
"order" : [
{
"reference" : "PRO-124",
"name" : "Producto de prueba",
"qty": 2,
"price": 70.5
}
],
"billing": {
"name" : "John",
"surname" : "Doe",
"taxId" : "2045520",
"email" : "[email protected]",
"phone" : "55555555",
"address" : "Guatemala City"
},
"redirection" : {
"successUrl" : "https://mysite.com/success"
}
}
number (Int)
Requerido Representa el Identificador de tu orden de compra, puede ser cualquier valor numérico que funcione como identificador dentro de tu sistema.
description (String)
Requerido Esta descripción es mostrada al cliente durante el proceso de pago.
amount (Decimal)
Requerido Valor del costo de la orden de compra.
currency (String)
String que representa la moneda en la cual se realizará el cobro, los valores aceptados por el momento son GTQ. Cuando este valor no es proporcionado por defecto, siempre será GTQ.
Facturación.
Objeto que provee la información del cliente. El objeto es requerido, pero tiene campos opcionales.
name (String)
Requerido Nombre del cliente.
surname (String)
Requerido Apellido del cliente.
taxId (String)
Número de NIT del cliente, dejar en blanco para CF.
email (String)
Requerido Email del cliente.
phone (String)
Teléfono del cliente.
address (String)
Dirección del cliente.
Redirección.
Objeto para especificar una ruta de redirección.
succesUrl (String)
URL al cual el link de pago regresará al momento de completar el pago satisfactoriamente.
Artículos de la orden.
Objeto para especificar los artículos que el cliente esta adquiriendo.
reference (String)
RequeridoEspecifica el id dentro de tu tienda del producto adquirido.
name (String)
RequeridoEspecifica el nombre dentro de tu tienda del producto adquirido.
qty (Int)
RequeridoEspecifica la cantidad de productos que el cliente está adquiriendo.
price (Double)
RequeridoEspecifica el precio unitario del producto adquirido.
cUrl
Aquí hay un ejemplo de la llamada al API en cUrl.
Recuerda que debes de agregar en el header el parámetro de X-TOKEN con el token que retorna la llamada de steup.
Copied!
curl -X 'POST' \
'https://aurora.codingtipi.com/pay/v2/vana/checkouts/hosted/single' \
-H 'accept: application/json' \
-H 'X-Token: add85aae-069a-404c-b0f2-bf006a323355' \
-H 'Content-Type: application/json'' \
-d '{
"number": 15,
"description": "Esta es una descripción",
"amount": 150.25,
"currency": "GTQ",
"order": [
{
"name": "PRO-123",
"surname": "Producto de prueba",
"qty": 2,
"price": 70.5
}
],
"billing": {
"reference": "John",
"name": "Doe",
"email": "[email protected]"
},
"redirection": {
"successUrl": "https://mysite.com/success"
}
}'
Respuesta
Aquí puedes encontrar el objeto que retorna la llamada con status Created 201. El objeto que retornó contiene los parámetros que necesitas del checkout de recurrente id que representa el id del checkout, metadata que representa información adicional del checkout y url que representa el URL del checkout, este parámetro es el que necesitas para redirigir al usuario hacia el checkout.
Copied!
{
"id" : "ch_l7zdlapspexiyu1",
"url" : "https://pay.vana.gt/session-123",
"metadata" : {
"clientToken" : "eyJhbGciOi",
"expiration" : "2025-01-01T00:00:00Z"
}
}
Códigos de Respuesta
Aquí puedes encontrar todos los posibles códigos de respuesta que el API puede contestar.