Crear Transacción Compra

Permite ejecutar una transacción de comprar enviando al API los datos del método de pago del cliente.

POST /TransaccionCompra​
Crear una Transacción de Compra
Ejemplo de Petición Básica
Ejemplo de petición solo con campos requeridos.
{
  "tarjetaCreditoDebido": {
    "numeroTarjeta": "string",
    "cvv": "string",
    "mesVencimiento": 0,
    "anioVencimiento": 0
  },
  "monto": 0,
  "emailCliente": "user@example.com",
  "nombreCliente": "string"
}
Ejemplo de Respuesta
{
  "idTransaccion": "string",
  "esReal": true,
  "esAprobada": true,
  "codigoAutorizacion": "string",
  "mensaje": "string",
  "formaPago": "PagoNormal",
  "monto": 0
}
Objeto Completo de Petición
En la sección anterior se definió una petición básica para crear una transacción de compra. En esta sección se detallan todas las propiedades opcionales que se pueden incluir.
JSON Completo
{
  "tarjetaCreditoDebido": {
    "numeroTarjeta": "string",
    "cvv": "string",
    "mesVencimiento": 0,
    "anioVencimiento": 0
  },
  "monto": 0,
  "emailCliente": "user@example.com",
  "nombreCliente": "string",
  "formaPago": "PagoNormal",
  "configuracion": {
    "emailsNotificacion": "string",
    "urlWebhook": "string",
    "notificarTransaccionCliente": true
  },
  "datosAdicionales": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "cantidadCuotas": "Uno"
}
Definición Campos Objeto Root
Campo
Es Requerido
Tipo Dato
Descripción
monto
si
double
El monto que se desea cargar a la tarjeta de crédito en la transacción
emailCliente
si
string
El e-mail del cliente que realiza la compra. Es de utilidad ya que allí es donde Wompi enviará una notificación de su compra al cliente su se activa dicha opción. 
nombreCliente
si
string
El nombre del cliente que realiza la compra.
formaPago
no
string
Permite especifica la forma de pago que se desea usar "PagoNomal" para compra con tarjeta de crédito o débito. "Puntos" para pagos con puntos de Banco Agrícola. "Cuotas" para pago en cuotas con tarjetas de crédito de Banco Agrícola. Si se omite se usa la opción de "PagoNormal". Para validar las formas de pago soportadas por su aplicativo consultar el end point de "Datos Aplicativo". 
cantidadCuotas
no
entero
Requerido únicamente si se esteblacio "Cuotas" como forma de pago. Para determinar la cantidad de cuotas que están disponibles para este aplicativo referirse al end point "Datos Aplicativo"
tarjetaCreditoDebito
si
Objeto
Ver definición de objeto abajo.
configuracion
no
Objeto
Ver definición de objeto abajo. Solo se necesita si se desea utilizar una configuración diferente a la que esta definida a nivel de aplicativo.
datosAdicionles
no
Diccionario
Permiten al cliente enviar una lista de Llave/Valor para identificar características adicionales de la transacción. Esta lista de Llave/Valor se entregan al comercio vía el webhook.
Definición de Objeto tarjetaCreditoDebido
Campo
Es Requerido
Tipo Dato
Descripción
numeroTarjeta
si
string
El numero de tarjeta sin espacios. 
cvv
si
string
Una cadena de caracteres solo con números con el CVV de la tarjeta a la que se le desea hacer el cobro
mesVencimiento
si
entero
El mes en que se vence la tarjeta
anioVencimiento
si
entero
El año en que se vence la tarjeta
Objeto Configuración
Campo
Es Requerido
Tipo Dato
Descripción
emailsNotificacion
no
string
Lista de correos electrónicos divididos por coma a los que se enviará una notificación si la transacción es exitosa.
urlWebhook
no
string
Url proporcionada por el comercio que se invocará con los datos de la transacción cuando esta sea exitosa. Los webhook son la manera principal que los sistemas del comercio se enteren de una transacción exitosa. Para más información ver la sección Webhook.
notificarTrsnaccionCliente
Si
bool
Indica si Wompi debe enviar una notificación por correo electrónico al cliente después de efectuar una transacción exitosa. El correo del cliente ex capturado en la interfaz de pago.
Datos Adicionales
Permiten al cliente enviar una lista de Llave/Valor para identificar características adicionales de la transacción. Esta lista de Llave/Valor se entregan al comercio vía el webhook.
Objeto de Respuesta
Campo
Tipo Dato
Descripción
idTransaccion
string
Identificador único de la transacción
esReal
bool
Verdadero si es un transacción ejecutada en producción, falso si es una transacción en desarrollo. La transacción en desarrollo no se cobra al cliente. 
esAprobada
bool
El cobro fu exitoso
codigoAutorizacion
string
Código de autorización de la transacción cuando es exitosa. Si esAprobada es falso este campo queda nulo. 
mensaje
string
Mensaje informativo retornado por el POS
formaPago
string
La forma de pago utilizada, "PagoNomal" (compras con tarjeta de crédito o débito). "Puntos" para pagos con puntos de Banco Agrícola. 
monto
decimal
El monto cobrado en la transacción

Métodos API - Previous

Crear Enlace de Pago

Next - Métodos API

Ejecutar Transacciones de Prueba

Last updated 2 months ago

Campo	Es Requerido	Tipo Dato	Descripción
monto	si	double	El monto que se desea cargar a la tarjeta de crédito en la transacción
emailCliente	si	string	El e-mail del cliente que realiza la compra. Es de utilidad ya que allí es donde Wompi enviará una notificación de su compra al cliente su se activa dicha opción.
nombreCliente	si	string	El nombre del cliente que realiza la compra.
formaPago	no	string	Permite especifica la forma de pago que se desea usar "PagoNomal" para compra con tarjeta de crédito o débito. "Puntos" para pagos con puntos de Banco Agrícola. "Cuotas" para pago en cuotas con tarjetas de crédito de Banco Agrícola. Si se omite se usa la opción de "PagoNormal". Para validar las formas de pago soportadas por su aplicativo consultar el end point de "Datos Aplicativo".
cantidadCuotas	no	entero	Requerido únicamente si se esteblacio "Cuotas" como forma de pago. Para determinar la cantidad de cuotas que están disponibles para este aplicativo referirse al end point "Datos Aplicativo"
tarjetaCreditoDebito	si	Objeto	Ver definición de objeto abajo.
configuracion	no	Objeto	Ver definición de objeto abajo. Solo se necesita si se desea utilizar una configuración diferente a la que esta definida a nivel de aplicativo.
datosAdicionles	no	Diccionario	Permiten al cliente enviar una lista de Llave/Valor para identificar características adicionales de la transacción. Esta lista de Llave/Valor se entregan al comercio vía el webhook.