Respuestas y Entidades

Introducción

Las respuestas y entidades proveen información adicional que puede ser de mucha importancia para los desarrolladores que utilicen el SDK, como ser documentación adicional en la forma de IntelliSense (información de parámetros de funciones, variables y módulos del SDK).

Respuestas

Dentro de los respuestas (categorizados como responses dentro del SDK) existen todos los distintos tipos de respuestas que se puede obtener al momento de hacer una consulta a los servicios de PixelPay.

Utilizando los tipos de respuestas, se puede determinar si una transacción realizada es exitosa o no. En caso de no ser exitosa, se puede capturar que tipo de error se generó. Todos los tipos de respuestas son equivalentes a uno o varios códigos de respuesta HTTP.

Tipo de respuesta Códigos HTTP Descripción
SuccessResponse 200 Respuesta exitosa
Posiblemente contenga información adicional en data.
ErrorResponse 400 Error general por parte del cliente
NoAccessResponse 401, 403 Error de permisos y/o accesos, el cliente no tiene acceso a este recurso. Puede que no haya enviado las credenciales necesarias o sus credenciales ya hayan expirado
PaymentDeclinedResponse 402 Error de transacción del pago declinada por el servicio
NotFoundResponse 404, 405, 406 No se encontró el recurso
TimeoutResponse 408 Se acabó el tiempo de respuesta del servidor
PreconditionalResponse 412, 418 Error donde las condiciones enviadas por el cliente no concuerdan con las condiciones del servicio
InputErrorResponse 422 Error de entidad enviada por el cliente donde falla la validación de un campo enviado
NetworkFailureResponse 500 Falla de comunicación con el servicio
FailureResponse >500 o falla de red Falla del servicio

Entities

Las entidades (categorizadas como entities dentro del SDK) proveen aún más información sobre el tipo de respuesta de parte de los servicios.

Todas las respuestas (por ejemplo: en formato JSON) tienen una estructura definida. Por ejemplo, muchas de las transacciones exitosas envían como respuesta una propiedad data. Las entidades ayudan a, dependiendo del tipo de servicio que se utiliza, definir en más detalle que exactamente contiene este componente.

Tipo de data Descripción Servicios que utilizan la entidad
CardResult Data en respuestas del servicio Tokenization CardTokenization
TransactionResult Data en respuestas del servicio Transaction AuthTransaction
CaptureTransaction
SaleTransaction
VoidTransaction

Entidad CardResult

Propiedad Tipo Descripción
status string Estado de la tarjeta
mask string Número de tarjeta enmascarado
network string Marca de la red de tarjetas
type string Tipo de tarjeta (débito/crédito)
bin string Número de contenedor de coche
last string Últimos 4 números de la tarjeta
hash string Número hash único de la tarjeta
address string Dirección de Envio
country string País de facturación
state string Estado de cuenta
city string Ciudad de facturación
zip string Código Postal de Facturación
email string Correo electrónico del cliente de facturación
phone string Teléfono de facturación

Entidad TransactionResult

Propiedad Tipo Descripción
transaction_type string Tipo de respuesta de transacción
transaction_approved_amount double Monto aprobado en captura/venta
transaction_amount double Importe de la transacción inicial o registrada
transaction_auth string Código de referencia AUTH de la transacción
transaction_terminal string ID de terminal de red de transacciones
transaction_merchant string ID de comerciante de la red de transacciones
response_cvn string Código de respuesta de resultado CVV2
response_avs string Respuesta del código de verificación de dirección
response_cavv string Código de resultado de evaluación de red CAVV
transaction_id string Identificador de transacción
transaction_reference string STAN de transacción, identificador de transacción del procesador o referencia de transacción
transaction_time string Tiempo de resultado de la transacción
transaction_date string Fecha de resultado de la transacción
response_approved boolean La respuesta es financieramente aprobada
response_incomplete boolean Respuesta fatal no completada o ejecución interrumpida
response_code string Código de respuesta del procesador
response_time string Tiempo de respuesta de la red
response_reason string Mensaje de respuesta del procesador
installment_type string Tipo de financiamiento de la transacción
installment_months string Cantidad de meses de financiamiento de la transacción
payment_uuid string Identificador único de pago
payment_hash string Hash de validación de integridad de pago