Peticiones

Introducción

Las peticiones (categorizados como requests dentro del SDK) son directrices que se encargan de tomar los datos requeridos de los modelos y convertirlos en una solicitud adecuada. La petición luego es enviada al sistema PixelPay. Por ejemplo: convertir nuestro pedido con varios artículos incluidos al formato JSON adecuado.

Por razones de seguridad, existe un límite de peticiones por minuto por dirección IP. Una vez que se llega a este límite, el cliente deberá esperar cierto tiempo antes de poder seguir generando peticiones.

Dentro de la categoría de peticiones se incluyen las directrices necesarias para realizar los diferentes tipos de pagos:

  • SaleTransaction: crea la solicitud para realizar una venta directa.
  • AuthTransaction: crea la solicitud para autorizar una venta. Una vez autorizada la venta, el comercio puede solicitar la captura del monto autorizado por medio del SDK.
  • CaptureTransaction: crea la solicitud para capturar el monto de una venta autorizada.
  • VoidTransaction: crea la solicitud para anular una venta.
  • StatusTransaction: crea la solicitud para obtener el estado de una transacción.
  • CardTokenization: crea la solicitud para tokenizar una tarjeta de crédito / débito.

Para utilizar los servicios necesitamos enviar nuestra información por medio de peticiones.

Los servicios que utilizan peticiones de tipo AuthTransaction, CaptureTransaction, SaleTransaction, VoidTransaction tambien pueden utilizar la entidad TransactionResult.

Los servicios que utilizan peticiones de tipo CardTokenization tambien pueden utilizar la entidad CardResult.

Autorización de venta AuthTransaction

La petición de AuthTransaction es necesario para crear transacciones donde queremos autorizar un pago para luego capturarlo en un futuro.

Siempre captura una transacción previamente autorizada. En caso de no querer capturar la transacción, debes hacer la anulación.

Este tipo de transacción congela los fondos de la tarjeta. El tiempo máximo de espera para realizar una captura son 15 días.

Propiedades de AuthTransaction

Firma de la propiedad Descripción
payment_uuid: string UUID de pago
card_token: string Identificador de tarjeta con token (formato T-*)
card_number: string Número de tarjeta o PAN
card_cvv: string Código de Seguridad de la Tarjeta
card_expire: string Fecha de vencimiento de la tarjeta año / mes (YYMM)
card_holder: string Nombre del titular de la tarjeta
billing_address: string Dirección de facturación del cliente
billing_country: string Código alfa-2 del país de facturación del cliente (ISO 3166-1)
billing_state: string Código alfa del estado de facturación del cliente (ISO 3166-2)
billing_city: string Ciudad de facturación del cliente
billing_zip: string Código postal de facturación del cliente
billing_phone: string Teléfono de facturación del cliente
customer_name: string Nombre del cliente del pedido
customer_email: string Correo electrónico del cliente
customer_fingerprint: string Identificador de huella del dispositivo del cliente
order_id: string ID del pedido
order_currency: string Código de moneda del pedido alpha-3
order_amount: string Importe total del pedido
order_tax_amount: string Importe total de impuestos del pedido
order_shipping_amount: string Importe total del envío del pedido
order_content: Item[] Resumen de pedidos de artículos o productos
order_extras: object Propiedades adicionales relacionadas al pedido
order_note: string Nota de pedido o instrucciones adicionales
order_callback: string URL de webhook de callback del pedido

Métodos de AuthTransaction

Función Parámetros Retorno Acceso
setCard card: Card void public

Asociar y mapear las propiedades del modelo de tarjeta a la transacción.

Función Parámetros Retorno Acceso
setCardToken token: string void public

Asociar y asignar propiedades del modelo de tarjeta tokenizada a la transacción.

Función Parámetros Retorno Acceso
setBilling billing: Billing void public

Asociar y asignar propiedades del modelo de facturación a la transacción.

Función Parámetros Retorno Acceso
setOrder order: Order void public

Asociar y asignar propiedades del modelo de pedido a la transacción.

Función Parámetros Retorno Acceso
withAuthenticationRequest void public

Habilita el servicio de 3DS en la transacción, solo es válido para las integraciones de iOS, Android y Browser JavaScript.

Es necesario habilitar el servicio 3DS en la integración del SDK, incluyendo la instrucción sale.withAuthenticationRequest() o auth.withAuthenticationRequest() según el caso. La llamada a este método debe de hacerse desde el lado del cliente (frontend).

Captura de venta CaptureTransaction

La petición de CaptureTransaction es necesario para crear transacciones donde queremos capturar un pago que ha sido autorizado anteriormente.

Propiedades de CaptureTransaction

Firma de la propiedad Descripción
payment_uuid: string UUID de pago
transaction_approved_amount: string La cantidad total a capturar, igual o menor que la cantidad autorizada

Venta directa SaleTransaction

La petición de SaleTransaction es necesario para transacciones donde queremos crear una venta directa.

Una venta directa es equivalente al proceso de una autorización y una captura inmediata.

Propiedades de SaleTransaction

Firma de la propiedad Descripción
payment_uuid: string UUID de pago
card_token: string Identificador de tarjeta con token (formato T-*)
card_number: string Número de tarjeta o PAN
card_cvv: string Código de Seguridad de la Tarjeta
card_expire: string Fecha de vencimiento de la tarjeta año / mes (YYMM)
card_holder: string Nombre del titular de la tarjeta
billing_address: string Dirección de facturación del cliente
billing_country: string Código alfa-2 del país de facturación del cliente (ISO 3166-1)
billing_state: string Código alfa del estado de facturación del cliente (ISO 3166-2)
billing_city: string Ciudad de facturación del cliente
billing_zip: string Código postal de facturación del cliente
billing_phone: string Teléfono de facturación del cliente
customer_name: string Nombre del cliente del pedido
customer_email: string Correo electrónico del cliente
customer_fingerprint: string Identificador de huella del dispositivo del cliente
order_id: string ID del pedido
order_currency: string Código de moneda del pedido alpha-3
order_amount: string Importe total del pedido
order_tax_amount: string Importe total de impuestos del pedido
order_shipping_amount: string Importe total del envío del pedido
order_content: Item[] Resumen de pedidos de artículos o productos
order_extras: object Propiedades adicionales relacionadas al pedido
order_note: string Nota de pedido o instrucciones adicionales
order_callback: string URL de webhook de callback del pedido
installment_type: string Tipo de financiamiento
installment_months: string Número de cuotas del financiamiento

Métodos de SaleTransaction

Función Parámetros Retorno Acceso
setCard card: Card void public

Asociar y mapear las propiedades del modelo de tarjeta a la transacción.

Función Parámetros Retorno Acceso
setCardToken token: string void public

Asociar y asignar propiedades del modelo de tarjeta tokenizada a la transacción.

Función Parámetros Retorno Acceso
setBilling billing: Billing void public

Asociar y asignar propiedades del modelo de facturación a la transacción.

Función Parámetros Retorno Acceso
setOrder order: Order void public

Asociar y asignar propiedades del modelo de pedido a la transacción.

Función Parámetros Retorno Acceso
setInstallment months: int
installment_type: string		 void public

Asociar y asignar propiedades de financiamiento a la transacción.

Función Parámetros Retorno Acceso
withAuthenticationRequest void public

Habilita el servicio de 3DS en la transacción, solo es válido para las integraciones de iOS, Android y Browser JavaScript.

Es necesario habilitar el servicio 3DS en la integración del SDK, incluyendo la instrucción sale.withAuthenticationRequest() o auth.withAuthenticationRequest() según el caso. La llamada a este método debe de hacerse desde el lado del cliente (frontend).

Estado de la venta StatusTransaction

La petición de StatusTransaction es necesario cuando queremos obtener el estatus de una transacción.

Obtenemos el UUID del pago de respuestas como payment_uuid en transacciones de tipo Auth, Capture y Sale.

Propiedades de StatusTransaction

Firma de la propiedad Descripción
payment_uuid: string UUID de pago

Anular una venta VoidTransaction

La petición de VoidTransaction es necesario para poder anular una transacción.

Es necesario establecer el parámetro auth_user utilizando el método setupPlatformUser del modelo Settings con el valor SHA-512 del correo electrónico del usuario autorizado para poder anular cobros.

Propiedades de VoidTransaction

Firma de la propiedad Descripción
payment_uuid: string UUID de pago
void_reason: string Razón de la anulación del pedido
void_signature: string Firma de la anulación del pago

Tokenización CardTokenization

La petición de CardTokenization es necesario para los servicios de tokenización de tarjetas.

Propiedades de CardTokenization

Firma de la propiedad Descripción
number: string Número de tarjeta o PAN
cvv2: string Código de Seguridad de la Tarjeta
expire_month: string Fecha del mes de vencimiento de la tarjeta (MM)
expire_year: string Fecha de vencimiento de la tarjeta (YYYY)
cardholder: string Nombre del titular de la tarjeta
address: string Dirección de facturación del cliente
country: string Código alfa-2 del país de facturación del cliente (ISO 3166-1)
state: string Código alfa del estado de facturación del cliente (ISO 3166-2)
city: string Ciudad de facturación del cliente
zip: string Código postal de facturación del cliente
phone: string Teléfono de facturación del cliente
email: string Correo electrónico del cliente

Métodos de CardTokenization

Función Parámetros Retorno Acceso
setCard card: Card void public

Asociar y mapear las propiedades del modelo de tarjeta a la transacción.

Función Parámetros Retorno Acceso
setBilling billing: Billing void public

Asociar y asignar propiedades del modelo de facturación a la transacción.