Los modelos (categorizados como models dentro del SDK) proveen clases predefinidas para facilitar la interacción con entidades de PixelPay, por ejemplo: tarjetas de crédito, órdenes, facturación, direcciones de entrega, etc.
Estos incluyen todas las definiciones necesarias para cubrir la mayoría de tipos de integración con PixelPay.
Dentro de los modelos podemos encontrar:
Settings: configuración del SDKBilling: datos de facturaciónCard: tarjetas de crédito / débitoItem: todo tipo de artículos a la ventaOrder: datos de pedidosLos modelos son necesarios, ya que son los componentes que fabrican las peticiones.
Settings contiene todas las propiedades necesarias para configurar el SDK, como ser guardar las llaves del comercio y el endpoint de PixelPay.
Settings| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
auth_key |
string |
public |
Clave de autenticación de la API del comercio (key ID).
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
auth_hash |
string |
public |
Hash MD5 de autenticación de API del comercio.
Al momento de configurar el auth_hash, esta debe ser exactamente el hash MD5 de clave secreta (secret key).
Por ejemplo, si la clave secreta de tu comercio es c0c485c0-4515-11ec-81d3-0242,
el hash de autenticación debe ser 79ac9a7ba7ced61faf750faa10e92037.
No compartas la clave secreta de tu comercio con nadie.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
auth_user |
string |
public |
Hash SHA-512 del correo electrónico del usuario autenticado del comercio.
Al momento de configurar el auth_user, esta debe ser exactamente el hash SHA-512 del correo electrónico del usuario.
Por ejemplo, si el correo electrónico del usuario de tu comercio es johndoe@email.test,
el hash debe empezar con 59f9ec68a047719a30d2e52cb79f1306184....
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
endpoint |
string |
public |
"https://pixelpay.app" |
URL del endpoint de la API del comercio. Puedes encontrar el endpoint de tu comercio siguiendo estas instrucciones.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
environment |
string |
public |
Entorno de la API del comercio. El entorno puede tener los valores de: live o sandbox.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
lang |
string |
public |
Lenguaje configurado para respuestas del API.
Settings| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
setupEndpoint |
endpoint: string |
void |
public |
Configurar URL del endpoint de la API del comercio.
| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
setupCredentials |
key: string hash: string |
void |
public |
Configurar llaves del comercio para la API. Recibe la llave identificadora del comercio (key ID) y el hash MD5 de la llave secreta del comercio (secret key).
| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
setupPlatformUser |
hash: string |
void |
public |
Configurar el usuario de la plataforma. Recibe el hash SHA-512 del correo electrónico del usuario autenticado del comercio.
| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
setupEnviroment |
env: string |
void |
public |
Configurar el entorno. Recibe el nuevo valor de entorno, puede tener los valores de: live, sandbox.
| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
setupSandbox |
void |
public |
Guarda la configuración por defecto para sandbox: URL del endpoint, llaves del comercio y el tipo de entorno sandbox.
| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
setupLanguage |
lang: String |
void |
public |
Guarda la configuración de lenguaje para las respuestas del API.
Billing es una clase que describe las propiedades para crear datos de facturación en PixelPay. Los datos de facturación son necesarios al momento de generar una venta o una tarjeta de crédito / débito tokenizada.
Billing| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
address |
string |
public |
Dirección de facturación del cliente.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
country |
string |
public |
Código alfa-2 del país de facturación del cliente (ISO-3166-1).
Es muy importante que se respete el formato descrito en la norma ISO-3166-1, puedes revisar los recursos de locaciones aquí).
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
state |
string |
public |
Código alfa del estado de facturación del cliente (ISO-3166-2).
Es muy importante que se respete el formato descrito en la norma ISO-3166-2, puedes revisar los recursos de locaciones aquí).
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
city |
string |
public |
Ciudad de facturación del cliente.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
zip |
string |
public |
Código postal de facturación del cliente.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
phone |
string |
public |
Teléfono de facturación del cliente.
Card es la clase que describe las propiedades para crear una tarjeta de crédito / débito en PixelPay.
Card| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
number |
string |
public |
Número de tarjeta o PAN.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
cvv2 |
string |
public |
Código de Seguridad de la Tarjeta.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
expire_month |
number |
public |
Fecha del mes de vencimiento de la tarjeta (MM).
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
expire_year |
number |
public |
Fecha de vencimiento de la tarjeta (YYYY).
Es muy importante que se respete el formato descrito anteriormente (YYYY), por ejemplo: 2022, 2023, 2024, etc.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
cardholder |
string |
public |
Nombre del titular de la tarjeta.
Card| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
getExpireFormat |
string |
public |
Obtener formato ISO de expiración de la tarjeta (YYMM).
Item es una clase que describe las propiedades para crear un artículo a la venta.
Item| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
code |
string |
public |
Código identificador de artículo o UPC / EAN.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
title |
string |
public |
Título del producto del artículo.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
price |
number |
public |
Artículo por precio unitario.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
qty |
number |
public |
Cantidad de artículos.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
tax |
number |
public |
Importe del impuesto sobre el artículo por unidad.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
total |
number |
public |
Valor total del artículo.
Item| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
totalize |
Item |
public |
Totalizar el precio del artículo por cantidad. Siempre que cambie el precio o la cantidad del objeto, podemos luego calcular el nuevo total con este método.
Order es una clase que posee todo lo necesario para crear un pedido en PixelPay.
Order| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
id |
string |
public |
ID del pedido.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
currency |
string |
public |
Código de moneda del pedido en alpha-3.
Puedes revisar la norma ISO 4217 para ver los distintos códigos de moneda disponibles.
Toma en cuenta que solo podrás utilizar los códigos de moneda disponibles en PixelPay.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
amount |
number |
public |
Importe total del pedido.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
tax_amount |
number |
public |
Importe total de impuestos del pedido.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
shipping_amount |
number |
public |
Importe total del envío del pedido.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
content |
List<Item> |
public |
Resumen de pedidos de artículos o productos.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
extras |
object |
public |
Propiedades adicionales relacionadas con el pedido.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
note |
string |
public |
Nota de pedido o instrucciones adicionales.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
callback_url |
string |
public |
URL de webhook de callback del pedido.
El callback_url es un webook que se activa cuando la transaccion ha sido pagada correctamente, y esta debe ser capaz de viajar hacia un servidor activo.
No está permitido utilizar un callback_url que no esté conectado a un dominio público (ej. localhost).
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
customer_name |
string |
public |
Nombre del cliente del pedido.
| Propiedad | Tipo | Acceso | Por defecto |
|---|---|---|---|
customer_email |
string |
public |
Correo electrónico del cliente.
Order| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
addItem |
item: Item |
Order |
public |
Agregar artículo a la lista de contenido de productos / artículos.
| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
addExtra |
key: string value: any |
Order |
public |
Permite agregar propiedades adicionales al pedido.
Los parámetros adicionales se verán reflejados en el envío de datos del webhook, y puede servir para desarrollos propios o personalizados.
| Función | Parámetros | Retorno | Acceso |
|---|---|---|---|
totalize |
Order |
public |
Calcular el total del pedido según todos los artículos que se han agregado. Siempre que cambie el precio o la cantidad de un artículo podemos luego calcular el nuevo total con este método.