NAV Navbar

Introducción

Bienvenido a la API de YAPSI.

Con nuestra API podrás integrar en tus proyectos una pasarela de pago segura, rápida y de bajo costo.

Para iniciar, deberás crear una cuenta de pruebas en nuestro ambiente de Sandbox publicado en https://www.yapsi.com.mx/sandbox/frontend/registro.aspx

Llaves de API

Para obtener la llaves de API, se deberá ingresar a https://www.yapsi.com.mx/sandbox/frontend y en la opción de menú MI CUENTA / Llaves API consultar el identificador de comercio {merchant_id} y generar o consultar la llave privada {private_key}.

Usuarios Sandbox

Para registrar cuenta de usuario de pruebas, se deberá ingresar a https://www.yapsi.com.mx/sandbox/frontend y en la opción de menú EMPRESA / Usuarios (Sandbox) registrar las cuentas de usuario.

La documentación oficial de la API la encontrarás en la dirección https://www.beyapsi.com/docs/api

Consideraciones generales

Objeto de respuesta JSON exitosa

{
  "objeto": { ... }
}

Objeto de respuesta JSON de error

{
  "error":{
    "code": 9999,
    "message": "Mensaje de error"
  }
}

Se deberá considerar como regla general que los endpoints responderán en formato JSON salvo para los casos en donde se especifique lo contrario.

Si la solicitud se hace con valores inválidos en sus parámetros, se responderá con un código de estado HTTP 4xx y una respuesta en formato JSON con el objeto error.

Si la solicitud no se procesa exitosamente, se responderá con un código de estado HTTP 5xx y una respuesta en formato JSON con el objeto error.

Si la solicitud se procesa exitosamente, se responderá con un código de estado HTTP 2xx y una respuesta en formato JSON.

URL Base de Sandbox

La URL Base del API de Sandbox que deberá utilizarse en los llamados a los endpoints es la siguiente:

https://www.yapsi.com.mx/sandbox/api/v1/

Autenticación

Para obtener acceso a nuestra API, es necesario obtener un token de sesión {session_token} con su identificador de comercio {merchant_id} y llave privada {private_key}.

Para todos los endpoint en donde se especifique, la API espera recibir el token de sesión mediante el encabezado de autorización:

Authorization: bearer {session_token}

Para obtener tus llaves de API, consulta Introducción.

Para obtener un token de sesión, consulta Llaves API / Validar.

Llaves API

Validar llaves API

Objeto de respuesta JSON

{
  "token":"Token de sesión {session_token}",
  "user": {
    "id":"00000000-0000-0000-0000-000000000000",
    "user_type_id":0,
    "user_type_name":"Tipo de usuario",
    "country_id":0,
    "country_name":"País",
    "state_id":0,
    "state_name":"Estado",
    "municipality_id":0,
    "municipality_name":"Municipio",
    "city_id":0,
    "city_name":"Ciudad",
    "nationality_id":0,
    "nationality_name":"Nacionalidad",
    "currency_id":0,
    "currency_name":"Moneda",
    "currency_iso_code":"Código ISO de la moneda",
    "currency_symbol":"Símbolo de la moneda",
    "banorte_provider_status_id":0,
    "banorte_provider_status_name":"Status de proveedor Banorte",
    "banorte_employee_status_id":0,
    "banorte_employee_status_name":"Status de empleado Banorte",
    "business_name":"Nombre del negocio",
    "first_name":"Primer nombre",
    "second_name":"Segundo nombre",
    "fathers_last_name":"Apellido paterno",
    "mothers_last_name":"Apellido materno",
    "tax_id_number":"RFC",
    "personal_id_code_number":"CURP",
    "personal_message":"Mensaje personal",
    "gender_id":0,
    "gender_name":"Genero",
    "marital_status_id":0,
    "marital_status_name":"Estado civil",
    "marital_regime_id":0,
    "marital_regime_name":"Régimen matrimonial",
    "occupation_id":0,
    "occupation_name":"Ocupación nacional",
    "education_level_id":0,
    "education_level_name":"Nivel educativo",
    "professional_title_id":0,
    "professional_title_name":"Profesión",
    "birthdate":"Fecha de nacimiento",
    "picture":"https://www.yapsi.com.mx/.../avatar.jpg",
    "account_number":"0000000000000",
    "complete_profile":false,
    "complete_expedient":false,
    "active_payroll_module":false,
    "active_stamp_payroll_module":false,
    "active_api_keys":false
    }
  }
}

Valida las llaves API compuestas por el Identificador del comercio {merchant_id} y la llave privada de sandbox {private_key} para obtener un token de sesión {session_token}.

Solicitud HTTP

POST https://www.yapsi.com.mx/sandbox/api/v1/keys/validate

Parámetros BODY (x-www-form-urlencoded)

Nombre Tipo Longitud Descripción
merchant_id string 36 Identificador del comercio
private_key string 36 Llave privada

Mensajes de error

Número Descripción
11251 Llaves de API del comercio inválidas, canceladas o revocadas
11252 No fue posible consultar comercio
11253 No fue posible generar sesión para el comercio

Consultar llaves API

Objeto de respuesta JSON

{
    "merchant_id": "00000000-0000-0000-0000-000000000000",
    "private_key": "00000000-0000-0000-0000-000000000000"
}

Consulta las llaves API, identificador del comercio {merchant_id} y la llave privada del comercio {private_key}

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/keys

Parámetros QUERY

Sin parámetros

Mensajes de error

Número Descripción
11301 No fue posible consultar llaves de API

Crear / Renovar llaves API

Objeto de respuesta JSON

{
    "private_key": "00000000-0000-0000-0000-000000000000"
}

Crea o renueva la llave privada de Sandbox

Solicitud HTTP

POST https://www.yapsi.com.mx/sandbox/api/v1/keys/private

Mensajes de error

Número Descripción
11351 No fue posible consultar llaves de API
11352 Llaves de API inactivas, no es posible Generar o Renovar

Transacciones

Crear transacciones

Objeto de respuesta JSON

{
    "transaction":{
        "id":"00000000-0000-0000-0000-000000000000",
        "transaction_type_id":0,
        "transaction_type_name":"Tipo de transacción",
        "transaction_status_id":0,
        "transaction_status_name":"Status de transacción",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "amount":0,
        "reference":"Referencia",
        "comments":"Comentarios",
        "user_name":"Nombre de usuario relacionado",
        "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
        "user": { Objeto user },
        "operator_name":"",
        "branch_office_name":"",
        "creation_date":"2018-10-12T09:05:11.497",
        "confirmation_date":"1900-01-01T00:00:00",
        "rejection_date":"1900-01-01T00:00:00"
    }
}

Crea operaciones de distintos tipos (catálogo) que se llevan a cabo entre WORKs y Usuarios YAPSI, que suponen el uso de dinero para sufragar el costo de bienes o servicios. Implican la afectación del saldos disponibles de monederos electrónicos (Y-Cards).

Solicitud HTTP

POST https://www.yapsi.com.mx/sandbox/api/v1/transactions

Parámetros BODY (x-www-form-urlencoded)

Nombre Tipo Requerido Descripción
transaction_type_id Integer Si Tipo de transacción (ver catálogo).
currency_id Integer Si Tipo de moneda (ver catálogo).
account_number string(13) Si Número de cuenta YAPSI del beneficiario (user.account_number)
amount numeric Si Monto de la transacción.
comments string(50) No Comentarios de la transacción.
wallet_code Integer No Código de la Y-Card (wallet.code)
Requerido para los tipos de transacciones:
27 = Devolución Y-Card
30 = Promoción puntos Y-Card

Mensajes de error

Número Descripción
4101 No es posible crear la transacción
4102 Número de cuenta no requerida para el tipo de transacción especificada
4103 Número de cuenta inválida
4104 Número de cuenta no puede ser el número de cuenta del Usuario, WORK o CAY
4105 Tipo de transacción no permitida para la cuenta de usuario
4112 No se tiene saldo en la moneda solicitada
4113 El saldo disponible es insuficiente para la moneda solicitada
4119 El operador proporcionado no pertenece a la cuenta de usuario o se encuentra inactivo
4120 La sucursal asignada al operador se encuentra inactiva
4121 No fue posible consultar la comisión de retiro
4122 El monto a digitalizar debe ser mayor al monto de la comisión
4123 No fue posible consultar políticas de retiro
4124 No se cumple con la política de mínimo de días para el primer retiro
4125 No se cumple con la política de saldo mínimo disponible para retiro
4126 Moneda inválida para calcular el saldo mínimo disponible para retiro
4127 No fue posible calcular la comisión de la transacción
4128 Saldo disponible insuficiente para el cobro de la comisión
4131 No fue posible consultar la comisión de pago
4132 El monto de pago debe ser mayor al monto de la comisión
4133 Saldo de Y-Card requerido para el tipo de transacción
4134 Saldo de Y-Card no requerido para el tipo de transacción
4135 Saldo de Y-Card no encontrado
4136 Saldo de Y-Card no puede ser afectado por esta cuenta de usuario
4137 La moneda del saldo de la Y-Card es diferente a la moneda de la transacción
4138 No fue posible consultar saldo de la Y-Card
4139 Saldo disponible insuficiente en el saldo de la Y-Card
4140 No fue posible relacionar transacción con el saldo de la Y-Card
15017 Código de Y-Card requerido
15018 Código de Y-Card no requerido para el tipo de transacción especificada
15019 Código de Y-Card inválido
15020 Y-Card no pertenece a la cuenta de usuario
15021 La Y-Card no se encuentra autorizada
15022 La moneda de la Y-Card es diferente a la moneda especificada
15023 Los puntos de la Y-Card vencieron, no es posible registrar la transacción
15024 Y-Card expirado, no es posible registrar la transacción
15025 Para el tipo de transacción especificada, se requiere la moneda 3 = Puntos
15026 La moneda 3 = Puntos es inválida para el tipo de transacción

Consultar transacciones

Objeto de respuesta JSON

{
    "transaction":{
        "id":"00000000-0000-0000-0000-000000000000",
        "transaction_type_id":0,
        "transaction_type_name":"Tipo de transacción",
        "transaction_status_id":0,
        "transaction_status_name":"Status de transacción",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "amount":0,
        "reference":"Referencia",
        "comments":"Comentarios",
        "user_name":"Nombre de usuario relacionado",
        "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
        "user": { Objeto user },
        "operator_name":"",
        "branch_office_name":"",
        "creation_date":"2018-10-12T09:05:11.497",
        "confirmation_date":"1900-01-01T00:00:00",
        "rejection_date":"1900-01-01T00:00:00"
    }
}

Se recupera una trasacción específica por su identificador (transaction.id).

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/transactions/{transaction_id}

Parámetros URL

Nombre Tipo Requerido Descripción
transaction_id string(36) Si Identificador de la transacción transaction.id

Listar transacciones

Objeto de respuesta JSON

{
    "transactions":[
        {
            "id":"00000000-0000-0000-0000-000000000000",
            "transaction_type_id":0,
            "transaction_type_name":"Tipo de transacción",
            "transaction_status_id":0,
            "transaction_status_name":"Status de transacción",
            "currency_id":0,
            "currency_name":"Moneda",
            "currency_iso_code":"Código ISO de la moneda",
            "currency_symbol":"Símbolo de la moneda",
            "amount":0,
            "reference":"Referencia",
            "comments":"Comentarios",
            "user_name":"Nombre de usuario relacionado",
            "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
            "user": { Objeto user },
            "operator_name":"",
            "branch_office_name":"",
            "creation_date":"2018-10-12T09:05:11.497",
            "confirmation_date":"1900-01-01T00:00:00",
            "rejection_date":"1900-01-01T00:00:00"
        },
        {
            "id":"00000000-0000-0000-0000-000000000000",
            "transaction_type_id":0,
            "transaction_type_name":"Tipo de transacción",
            "transaction_status_id":0,
            "transaction_status_name":"Status de transacción",
            "currency_id":0,
            "currency_name":"Moneda",
            "currency_iso_code":"Código ISO de la moneda",
            "currency_symbol":"Símbolo de la moneda",
            "amount":0,
            "reference":"Referencia",
            "comments":"Comentarios",
            "user_name":"Nombre de usuario relacionado",
            "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
            "user": { Objeto user },
            "operator_name":"",
            "branch_office_name":"",
            "creation_date":"2018-10-12T09:05:11.497",
            "confirmation_date":"1900-01-01T00:00:00",
            "rejection_date":"1900-01-01T00:00:00"
        }
    ],
    "total_rows":0
}

Se obtiene una lista de transacciones.

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/transactions

Parámetros QUERY

Nombre Tipo Requerido Descripción
creation_from date Si Fecha de creación desde...
creation_to date Si Fecha de creación hasta...
transaction_type_id integer No Tipo de transacción.
transaction_status_id integer No Status de transacción.
operador_id string(32) No Identificador de operador; aplica solo para WORKs y CAYs.
branch_office_id string(32) No Identificador de sucursal; aplica solo para WORKs y CAYs.
reference string(20) No Referencia de transacción.
comments string(50) No Comentarios de la transacción.
account_number string No Número de cuenta del usuario YAPSI beneficiario.
offset integer No Número de registros a omitir al inicio de la lista (default = 0).
limit integer No Límite de registros a retornar (default = 10).
sort_by string(50) No Puede contener uno de los siguientes valores: reference, transaction_status_name, transaction_type_name, amount, user_name, creation_date.
Para orden ascendente, enviar el nombre del campo, para orden descendente enviar el nombre del campo seguido de un espacio y la palabra "desc".

Cancelar transacciones

Objeto de respuesta JSON

{
    "transaction":{
        "id":"00000000-0000-0000-0000-000000000000",
        "transaction_type_id":0,
        "transaction_type_name":"Tipo de transacción",
        "transaction_status_id":0,
        "transaction_status_name":"Status de transacción",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "amount":0,
        "reference":"Referencia",
        "comments":"Comentarios",
        "user_name":"Nombre de usuario relacionado",
        "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
        "user": { Objeto user },
        "operator_name":"",
        "branch_office_name":"",
        "creation_date":"2018-10-12T09:05:11.497",
        "confirmation_date":"1900-01-01T00:00:00",
        "rejection_date":"1900-01-01T00:00:00"
    }
}

Crea una transacción que tiene la finalidad de cancelar o aplicar reversa a una transacción erronea efectuada previamente.

Solicitud HTTP

POST https://www.yapsi.com.mx/sandbox/api/v1/transactions/{transaction_id}/cancel

Parámetros URL

Nombre Tipo Requerido Descripción
transaction_id string(36) Si Identificador de la transacción transaction.id

Parámetros BODY (x-www-form-urlencoded)

Nombre Tipo Requerido Descripción
comments string(50) No Comentarios de la transacción

Mensajes de error

Número Descripción
4350 Identificador de transacción inválido
4351 El usuario no está relacionado a la transacción
4352 La transacción a cancelar no está aplicada
4353 Tipo de transacción inválida
4354 Error al consultar el monto total de la transacción a cancelar
4355 Error al consultar el saldo disponible de la transacción a cancelar
4356 Saldo disponible insuficiente
4357 Error al consultar el saldo de la Y-Card
4358 Saldo disponible de la Y-Card insuficiente
4359 Error al registrar la cancelación, consultar con el área técnica YAPSI
4360 Error al registrar transacciones adicionales (IVA, comisión, etc.)
4361 Error al relacionar la trasnacción de cancelación con la Y-Card
4362 Error al consultar al beneficiario
4363 Error al registrar el mensaje de la cancelación

Tokens transacciones

Validar tokens transacciones

Objeto de respuesta JSON

{
    "transaction":{
        "id":"00000000-0000-0000-0000-000000000000",
        "transaction_type_id":0,
        "transaction_type_name":"Tipo de transacción",
        "transaction_status_id":0,
        "transaction_status_name":"Status de transacción",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "amount":0,
        "reference":"Referencia",
        "comments":"Comentarios",
        "user_name":"Nombre de usuario relacionado",
        "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
        "user": { Objeto user },
        "operator_name":"",
        "branch_office_name":"",
        "creation_date":"2018-10-12T09:05:11.497",
        "confirmation_date":"1900-01-01T00:00:00",
        "rejection_date":"1900-01-01T00:00:00"
    }
}

Aplica un token de transacción a un WORK o CAY.

Solicitud HTTP

POST https://www.yapsi.com.mx/sandbox/api/v1/token/transaction/validate

Parámetros BODY (x-www-form-urlencoded)

Nombre Tipo Requerido Descripción
transaction_token string(15) Si Token de transacción
comments string(50) No Comentarios de la transacción
transaction_type_id int No Tipo de transacción del token a aplicar.
Los campos transaction_type_id, currency_id y amount, deberán proporcionarse solo cuando se desee validar el tipo de la transacción, la moneda y el monto del token de transacción a aplicar.
Si el tipo de la transacción, la moneda y el monto no llegarán a coincidir, el token de transacción no se aplica y se cancela.
Solo se aceptan los tipos de transacción:
3 = Retiro (CAY)
6 = Pago
28 = Pago Y-Card
31= Pago puntos Y-Card
currency_id int No Moneda del token transacción a aplicar.
Los campos transaction_type_id, currency_id y amount, deberán proporcionarse solo cuando se desee validar el tipo de la transacción, la moneda y el monto del token de transacción a aplicar.
Si el tipo de la transacción, la moneda y el monto no llegarán a coincidir, el token de transacción no se aplica y se cancela.
amount numeric No Monto del token de transacción a aplicar.
Deberá proporcionarse junto con el campo transaction_type_id solo cuando se desee validar el tipo de la transacción y el monto del token de transacción a aplicar.
Si el tipo de la transacción, la moneda y el monto no llegarán a coincidir, el token de transacción no se aplica y se cancela.

Mensajes de error

Número Descripción
6201 No es posible validar token de transacción
6202 Token no existe
6203 No es posible procesar la transacción asociada al token
6204 El token no puede procesarse con esta cuenta de usuario
6205 No es posible procesar un token con moneda diferente a la moneda local del usuario
6206 El token expiró
6207 El token ya fue utilizado
6208 No es posible consultar comisión de retiro
6209 El monto de la comisión de retiro es mayor al monto del token
6210 No es posible registrar comisión de retiro
6211 No es posible aplicar transacciones relacionadas
6215 Tipo de transacción inválida, solo los tipos 3 = Retiro, 6 = Pago, 28 = Payo Y-Card y 30 = Pago puntos Y-Card son aceptados
6216 Tipo de transacción, Moneda y Monto son requeridos
6217 Tipo de transacción no corresponde al tipo de transacción del token
6218 Moneda no corresponde a la moneda del token
6219 Monto no corresponde al monto del token

Consultar tokens transacciones

Objeto de respuesta JSON

{
    "transaction":{
        "id":"00000000-0000-0000-0000-000000000000",
        "transaction_type_id":0,
        "transaction_type_name":"Tipo de transacción",
        "transaction_status_id":0,
        "transaction_status_name":"Status de transacción",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "amount":0,
        "reference":"Referencia",
        "comments":"Comentarios",
        "user_name":"Nombre de usuario relacionado",
        "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
        "user": { Objeto user },
        "operator_name":"",
        "branch_office_name":"",
        "creation_date":"2018-10-12T09:05:11.497",
        "confirmation_date":"1900-01-01T00:00:00",
        "rejection_date":"1900-01-01T00:00:00"
    }
}

Consulta un token de transacción.

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/token/transaction

Parámetros QUERY

Nombre Tipo Requerido Descripción
transaction_token string(15) Si Token de transacción

Mensajes de error

Número Descripción
6251 Error al consultar el token de transacción
6252 El token no existe
6253 El token ya fue utilizado
6254 El token expiró

Y-Cards

Crear Y-Cards

Objeto de respuesta JSON

{
    "wallet":{
        "id":"00000000-0000-0000-0000-000000000000",
        "wallet_type_id":0,
        "wallet_type_name":"Tipo de Y-Card",
        "wallet_status_id":0,
        "wallet_status_name":"Status de monedero",
        "wallet_design_id":0,
        "wallet_design_name":"Diseño",
        "wallet_category_1_id":0,
        "wallet_category_1_name":"Categoría de monedero",
        "wallet_sub_category_1_id":0,
        "wallet_sub_category_1_name":"Sub categoría de monedero",
        "wallet_category_2_id":0,
        "wallet_category_2_name":"Categoría de monedero",
        "wallet_sub_category_2_id":0,
        "wallet_sub_category_2_name":"Sub categoría de monedero",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "code":0,
        "name":"Nombre del monedero",
        "display_name":true,
        "text_color":"000000",
        "background_color":"000000",
        "description":"Descripción del monedero",
        "terms_conditions":"Términos y condiciones",
        "privacy_policies":"Políticas de privacidad",
        "url_terms_conditions":"URL de términos y condiciones",
        "url_privacy_policies":"URL de políticas de privacidad",
        "url_logotype":"https://www.yapsi.com.mx/sandbox/.../logotipo.jpg",
        "url_image":"https://www.yapsi.com.mx/sandbox/.../imagen.jpg",
        "url_redirect":"URL de redirección",
        "points_expiration_date":"1900-01-01T00:00:00",
        "wallet_expiration_date":"1900-01-01T00:00:00",
        "creation_date":"1900-01-01T00:00:00",
        "modification_date":"1900-01-01T00:00:00",
        "discharge_date":"1900-01-01T00:00:00",
        "owner":{ Objeto user },
        "merchant":{ Objeto user },
        "wallet_balance":{ Objeto wallet_balance },
        "quantity_wallet_balances":0
    }
}

Registra una Y-Card pública para un WORK o CAY.

En el ambiente de Sandbox, las Y-Card registradas se autorizarán automáticamente para que pueda ser guadadas por las cuenta de usuario de pruebas.

En el ambiente de Producción, las Y-Card registradas, serán revisadas y autorizadas por YAPSI siempre y cuando estás cumplan con los lineamientos de diseño.

Solicitud HTTP

POST https://www.yapsi.com.mx/sandbox/api/v1/wallets

Parámetros BODY (x-www-form-urlencoded)

Nombre Tipo Requerido Descripción
wallet_type_id integer Si Tipo de la Y-Card (ver catálogo)
wallet_design_id integer Si Diseño de la Y-Card (ver catálogo)
wallet_category_1_id integer Si Categoría 1 de la Y-Card (ver catálogo)
wallet_sub_category_1_id integer Si Sub Categoría 1 de la Y-Card (ver catálogo)
wallet_category_2_id integer No Categoría 2 de la Y-Card (ver catálogo)
Valor predeterminado 0.
wallet_sub_category_2_id integer No Sub Categoría 2 de la Y-Card (ver catálogo)
Valor predeterminado 0.
currency_id integer Si Moneda (ver catálogo)
name string(70) Si Nombre
display_name boolean Si Mostrar nombre
text_color string(6) Si Color del texto
background_color string(6) Si Color de fondo
description string(1000) No Descripción
terms_conditions string No Términos y condiciones
privacy_policies string No Políticas de privacidad
url_terms_conditions string(255) No URL de los términos y condiciones
url_privacy_policies string(255) No URL de las políticas de privacidad
url_redirect string(255) No URL de redirección
points_expiration_date datetime No Fecha de vigencia de los puntos.
Requerida cuando la moneda es 3 = Puntos.
Al cumplirse esta fecha se registrará en automático un movimiento de expiración de puntos Y-Card.
wallet_expiration_date datetime No Fecha de vigencia de la Y-Card.
Valor predeterminado 9999/12/30.
Al cumplirse esta fecha no se podrá bonificar a la Y-Card.

Mensajes de error

Número Descripción
16151 La Categoría / Sub Categoría 1 de la Y-Card es inválida
16152 La Categoría / Sub Categoría 2 de la Y-Card es inválida
16153 No fue posible registrar la Y-Card, revise la información capturada e intente de nuevo
16154 Fecha de vigencia de la Y-Card debe ser mayor a la fecha actual
16155 Fecha de vigencia de puntos debe ser mayor a la fecha actual
16156 Fecha de vigencia de puntos debe ser menor o igual a la fecha de vigencia de la Y-Card

Editar Y-Cards

Edita una Y-Card pública de un Work o CAY.

Solicitud HTTP

PUT https://www.yapsi.com.mx/sandbox/api/v1/wallets/{wallet_id}

Parámetros URL

Nombre Tipo Requerido Descripción
wallet_id string(36) Si Identificador de la Y-Card wallet.id

Parámetros BODY (x-www-form-urlencoded)

Nombre Tipo Requerido Descripción
wallet_design_id integer Si Diseño de la Y-Card (ver catálogo)
wallet_category_1_id integer Si Categoría 1 de la Y-Card (ver catálogo)
wallet_sub_category_1_id integer Si Sub Categoría 1 de la Y-Card (ver catálogo)
wallet_category_2_id integer No Categoría 2 de la Y-Card (ver catálogo)
Valor predeterminado 0.
wallet_sub_category_2_id integer No Sub Categoría 2 de la Y-Card (ver catálogo)
Valor predeterminado 0.
name string(70) Si Nombre
display_name boolean Si Mostrar nombre
text_color string(6) Si Color del texto
background_color string(6) Si Color de fondo
description string(1000) No Descripción
terms_conditions string No Términos y condiciones
privacy_policies string No Políticas de privacidad
url_terms_conditions string(255) No URL de los términos y condiciones
url_privacy_policies string(255) No URL de las políticas de privacidad
url_redirect string(255) No URL de redirección
points_expiration_date datetime No Fecha de vigencia de los puntos.
Requerida cuando la moneda es 3 = Puntos.
Al cumplirse esta fecha se registrará en automático un movimiento de expiración de puntos Y-Card.
wallet_expiration_date datetime No Fecha de vigencia de la Y-Card.
Valor predeterminado 9999/12/30.
Al cumplirse esta fecha no se podrá bonificar a la Y-Card.

Mensajes de error

Número Descripción
16251 Identificador de la Y-Card inválido
16252 La Y-Card no pertenece al usuario
16253 La Categoría / Sub Categoría 1 de la Y-Card es inválida
16254 La Categoría / Sub Categoría 2 de la Y-Card es inválida
16255 No fue posible actualizar la Y-Card, revise la información captura e intente de nuevo
16256 Status de la Y-Card diferente a por Autorizar, no es posible editar
16257 Fecha de vigencia de la Y-Card debe ser mayor a la fecha actual
16258 Fecha de vigencia de los puntos debe ser mayor a la fecha actual
16259 Fecha de vigencia de los puntos debe ser menor o igual a la fecha de vigencia de la Y-Card

Actualizar logotipo Y-Cards

Objeto de respuesta JSON

{
    "wallet":{
        "id":"00000000-0000-0000-0000-000000000000",
        "wallet_type_id":0,
        "wallet_type_name":"Tipo de Y-Card",
        "wallet_status_id":0,
        "wallet_status_name":"Status de monedero",
        "wallet_design_id":0,
        "wallet_design_name":"Diseño",
        "wallet_category_1_id":0,
        "wallet_category_1_name":"Categoría de monedero",
        "wallet_sub_category_1_id":0,
        "wallet_sub_category_1_name":"Sub categoría de monedero",
        "wallet_category_2_id":0,
        "wallet_category_2_name":"Categoría de monedero",
        "wallet_sub_category_2_id":0,
        "wallet_sub_category_2_name":"Sub categoría de monedero",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "code":0,
        "name":"Nombre del monedero",
        "display_name":true,
        "text_color":"000000",
        "background_color":"000000",
        "description":"Descripción del monedero",
        "terms_conditions":"Términos y condiciones",
        "privacy_policies":"Políticas de privacidad",
        "url_terms_conditions":"URL de términos y condiciones",
        "url_privacy_policies":"URL de políticas de privacidad",
        "url_logotype":"https://www.yapsi.com.mx/sandbox/.../logotipo.jpg",
        "url_image":"https://www.yapsi.com.mx/sandbox/.../imagen.jpg",
        "url_redirect":"URL de redirección",
        "points_expiration_date":"1900-01-01T00:00:00",
        "wallet_expiration_date":"1900-01-01T00:00:00",
        "creation_date":"1900-01-01T00:00:00",
        "modification_date":"1900-01-01T00:00:00",
        "discharge_date":"1900-01-01T00:00:00",
        "owner":{ Objeto user },
        "merchant":{ Objeto user },
        "wallet_balance":{ Objeto wallet_balance },
        "quantity_wallet_balances":0
    }
}

Actualiza el logotipo de una Y-Card.

Solicitud HTTP

PUT https://www.yapsi.com.mx/sandbox/api/v1/wallets/{wallet_id}/logotype

Parámetros URL

Nombre Tipo Requerido Descripción
wallet_id string(36) Si Identificador de la Y-Card wallet.id

Parámetros BODY (form-data)

Nombre Tipo Requerido Descripción
logotype binary Si Logotipo de la Y-Card

Mensajes de error

Número Descripción
16301 Identificador de la Y-Card inválida
16302 La Y-Card no pertenece al usuario
16303 No es posible actualizar el logotipo de una Y-Card cancelado
16304 No fue posible guardar logotipo
16305 No fue posible actualizar logotipo

Actualizar imagen Y-Cards

Objeto de respuesta JSON

{
    "wallet":{
        "id":"00000000-0000-0000-0000-000000000000",
        "wallet_type_id":0,
        "wallet_type_name":"Tipo de Y-Card",
        "wallet_status_id":0,
        "wallet_status_name":"Status de monedero",
        "wallet_design_id":0,
        "wallet_design_name":"Diseño",
        "wallet_category_1_id":0,
        "wallet_category_1_name":"Categoría de monedero",
        "wallet_sub_category_1_id":0,
        "wallet_sub_category_1_name":"Sub categoría de monedero",
        "wallet_category_2_id":0,
        "wallet_category_2_name":"Categoría de monedero",
        "wallet_sub_category_2_id":0,
        "wallet_sub_category_2_name":"Sub categoría de monedero",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "code":0,
        "name":"Nombre del monedero",
        "display_name":true,
        "text_color":"000000",
        "background_color":"000000",
        "description":"Descripción del monedero",
        "terms_conditions":"Términos y condiciones",
        "privacy_policies":"Políticas de privacidad",
        "url_terms_conditions":"URL de términos y condiciones",
        "url_privacy_policies":"URL de políticas de privacidad",
        "url_logotype":"https://www.yapsi.com.mx/sandbox/.../logotipo.jpg",
        "url_image":"https://www.yapsi.com.mx/sandbox/.../imagen.jpg",
        "url_redirect":"URL de redirección",
        "points_expiration_date":"1900-01-01T00:00:00",
        "wallet_expiration_date":"1900-01-01T00:00:00",
        "creation_date":"1900-01-01T00:00:00",
        "modification_date":"1900-01-01T00:00:00",
        "discharge_date":"1900-01-01T00:00:00",
        "owner":{ Objeto user },
        "merchant":{ Objeto user },
        "wallet_balance":{ Objeto wallet_balance },
        "quantity_wallet_balances":0
    }
}

Actualiza la imagen de una Y-Card.

Solicitud HTTP

PUT https://www.yapsi.com.mx/sandbox/api/v1/wallets/{wallet_id}/image

Parámetros URL

Nombre Tipo Requerido Descripción
wallet_id string(36) Si Identificador de la Y-Card wallet.id

Parámetros BODY (form-data)

Nombre Tipo Requerido Descripción
image binary Si Imagen de la Y-Card

Mensajes de error

Número Descripción
16351 Identificador de la Y-Card inválida
16352 La Y-Card no pertenece al usuario
16353 No es posible actualizar la imagen de una Y-Card cancelado
16354 No fue posible guardar imagen
16355 No fue posible actualizar imagen

Eliminar Y-Cards

Respuesta vacía

Elimina una Y-Card de un Work o CAY.

Solicitud HTTP

DELETE https://www.yapsi.com.mx/sandbox/api/v1/wallets/{wallet_id}

Parámetros URL

Nombre Tipo Requerido Descripción
wallet_id string(36) Si Identificador de la Y-Card wallet.id

Mensajes de error

Número Descripción
16401 Identificador de la Y-Card inválido
16402 La Y-Card no pertenece al usuario
16403 Status de la Y-Card es diferente a Por autorizar o Autorizada
16404 La Y-Card no puede eliminarse debido a que esta relacionada con usuarios
16405 No fue posible cancelar la Y-Card

Consultar Y-Cards

Objeto de respuesta JSON

{
    "wallet":{
        "id":"00000000-0000-0000-0000-000000000000",
        "wallet_type_id":0,
        "wallet_type_name":"Tipo de Y-Card",
        "wallet_status_id":0,
        "wallet_status_name":"Status de monedero",
        "wallet_design_id":0,
        "wallet_design_name":"Diseño",
        "wallet_category_1_id":0,
        "wallet_category_1_name":"Categoría de monedero",
        "wallet_sub_category_1_id":0,
        "wallet_sub_category_1_name":"Sub categoría de monedero",
        "wallet_category_2_id":0,
        "wallet_category_2_name":"Categoría de monedero",
        "wallet_sub_category_2_id":0,
        "wallet_sub_category_2_name":"Sub categoría de monedero",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "code":0,
        "name":"Nombre del monedero",
        "display_name":true,
        "text_color":"000000",
        "background_color":"000000",
        "description":"Descripción del monedero",
        "terms_conditions":"Términos y condiciones",
        "privacy_policies":"Políticas de privacidad",
        "url_terms_conditions":"URL de términos y condiciones",
        "url_privacy_policies":"URL de políticas de privacidad",
        "url_logotype":"https://www.yapsi.com.mx/sandbox/.../logotipo.jpg",
        "url_image":"https://www.yapsi.com.mx/sandbox/.../imagen.jpg",
        "url_redirect":"URL de redirección",
        "points_expiration_date":"1900-01-01T00:00:00",
        "wallet_expiration_date":"1900-01-01T00:00:00",
        "creation_date":"1900-01-01T00:00:00",
        "modification_date":"1900-01-01T00:00:00",
        "discharge_date":"1900-01-01T00:00:00",
        "owner":{ Objeto user },
        "merchant":{ Objeto user },
        "wallet_balance":{ Objeto wallet_balance },
        "quantity_wallet_balances":0
    }
}

Consulta una Y-Card especifica de un WORK o un CAY por medio del identificador de la Y-Card.

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/wallets/{wallet_id}

Parámetros URL

Nombre Tipo Requerido Descripción
wallet_id string(36) Si Identificador de la Y-Card wallet.id

Mensajes de error

Número Descripción
16101 Identificador de la Y-Card inválido

Listar Y-Cards

Objeto de respuesta JSON

{
    "wallets":[
        {
            "id":"00000000-0000-0000-0000-000000000000",
            "wallet_type_id":0,
            "wallet_type_name":"Tipo de Y-Card",
            "wallet_status_id":0,
            "wallet_status_name":"Status de monedero",
            "wallet_design_id":0,
            "wallet_design_name":"Diseño",
            "wallet_category_1_id":0,
            "wallet_category_1_name":"Categoría de monedero",
            "wallet_sub_category_1_id":0,
            "wallet_sub_category_1_name":"Sub categoría de monedero",
            "wallet_category_2_id":0,
            "wallet_category_2_name":"Categoría de monedero",
            "wallet_sub_category_2_id":0,
            "wallet_sub_category_2_name":"Sub categoría de monedero",
            "currency_id":0,
            "currency_name":"Moneda",
            "currency_iso_code":"Código ISO de la moneda",
            "currency_symbol":"Símbolo de la moneda",
            "code":0,
            "name":"Nombre del monedero",
            "display_name":true,
            "text_color":"000000",
            "background_color":"000000",
            "description":"Descripción del monedero",
            "terms_conditions":"Términos y condiciones",
            "privacy_policies":"Políticas de privacidad",
            "url_terms_conditions":"URL de términos y condiciones",
            "url_privacy_policies":"URL de políticas de privacidad",
            "url_logotype":"https://www.yapsi.com.mx/sandbox/.../logotipo.jpg",
            "url_image":"https://www.yapsi.com.mx/sandbox/.../imagen.jpg",
            "url_redirect":"URL de redirección",
            "points_expiration_date":"1900-01-01T00:00:00",
            "wallet_expiration_date":"1900-01-01T00:00:00",
            "creation_date":"1900-01-01T00:00:00",
            "modification_date":"1900-01-01T00:00:00",
            "discharge_date":"1900-01-01T00:00:00",
            "owner":{ Objeto user },
            "merchant":{ Objeto user },
            "wallet_balance":{ Objeto wallet_balance },
            "quantity_wallet_balances":0
        },
        {
            "id":"00000000-0000-0000-0000-000000000000",
            "wallet_type_id":0,
            "wallet_type_name":"Tipo de Y-Card",
            "wallet_status_id":0,
            "wallet_status_name":"Status de monedero",
            "wallet_design_id":0,
            "wallet_design_name":"Diseño",
            "wallet_category_1_id":0,
            "wallet_category_1_name":"Categoría de monedero",
            "wallet_sub_category_1_id":0,
            "wallet_sub_category_1_name":"Sub categoría de monedero",
            "wallet_category_2_id":0,
            "wallet_category_2_name":"Categoría de monedero",
            "wallet_sub_category_2_id":0,
            "wallet_sub_category_2_name":"Sub categoría de monedero",
            "currency_id":0,
            "currency_name":"Moneda",
            "currency_iso_code":"Código ISO de la moneda",
            "currency_symbol":"Símbolo de la moneda",
            "code":0,
            "name":"Nombre del monedero",
            "display_name":true,
            "text_color":"000000",
            "background_color":"000000",
            "description":"Descripción del monedero",
            "terms_conditions":"Términos y condiciones",
            "privacy_policies":"Políticas de privacidad",
            "url_terms_conditions":"URL de términos y condiciones",
            "url_privacy_policies":"URL de políticas de privacidad",
            "url_logotype":"https://www.yapsi.com.mx/sandbox/.../logotipo.jpg",
            "url_image":"https://www.yapsi.com.mx/sandbox/.../imagen.jpg",
            "url_redirect":"URL de redirección",
            "points_expiration_date":"1900-01-01T00:00:00",
            "wallet_expiration_date":"1900-01-01T00:00:00",
            "creation_date":"1900-01-01T00:00:00",
            "modification_date":"1900-01-01T00:00:00",
            "discharge_date":"1900-01-01T00:00:00",
            "owner":{ Objeto user },
            "merchant":{ Objeto user },
            "wallet_balance":{ Objeto wallet_balance },
            "quantity_wallet_balances":0
        }
    ],
    "total_rows":0
}

Lista Y-Cards del Work o CAY.

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/wallets

Parámetros QUERY

Nombre Tipo Requerido Descripción
wallet_status_id integer No Status de la Y-Card (ver catálogo)
wallet_type_id integer Si Tipo de la Y-Card (ver catálogo)
wallet_design_id integer Si Diseño de la Y-Card (ver catálogo)
wallet_category_1_id integer Si Categoría 1 de la Y-Card (ver catálogo)
wallet_sub_category_1_id integer Si Sub Categoría 1 de la Y-Card (ver catálogo)
currency_id integer Si Moneda ver catálogo
code integer No Código de la Y-Card
name string(50) No Nombre de la Y-Card
creation_from date No Fecha de creación desde
creation_to date No Fecha de creación hasta
wallet_balance_code integer No Número de la Y-Card wallet_balance.code
offset integer No Número de registros a omitir al inicio de la lista de registros.
Valor predeterminado 0.
limit integer No Limite de registros a retornar.
Valor predeterminado 10.

Mensajes de error

Número Descripción
16101 Identificador de la Y-Card inválido

Listas saldos Y-Card

Objeto de respuesta JSON

{
    "wallets_balances":[
        {
            "id":"00000000-0000-0000-0000-000000000000",
            "merchant": { Objeto user },
            "user_name":"Nombre del usuario",
            "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
            "account_number":"0000000000000",
            "currency_id":0,
            "currency_name":"Moneda",
            "currency_iso_code":"Código ISO de la moneda",
            "currency_symbol":"Símbolo de la moneda",
            "code":0,
            "balance":0,
            "balance_locked":0,
            "balance_available":0,
            "disabled":false,
            "creation_date":"1900-01-01T00:00:00",
            "modification_date":"1900-01-01T00:00:00"
        },
        {
            "id":"00000000-0000-0000-0000-000000000000",
            "merchant": { Objeto user },
            "user_name":"Nombre del usuario",
            "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
            "account_number":"0000000000000",
            "currency_id":0,
            "currency_name":"Moneda",
            "currency_iso_code":"Código ISO de la moneda",
            "currency_symbol":"Símbolo de la moneda",
            "code":0,
            "balance":0,
            "balance_locked":0,
            "balance_available":0,
            "disabled":false,
            "creation_date":"1900-01-01T00:00:00",
            "modification_date":"1900-01-01T00:00:00"
        }
    ],
    "total_rows":0
}

Listar saldos de las Y-Cards.

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/walletbalances

Parámetros QUERY

Nombre Tipo Requerido Descripción
wallet_code integer No Código de la Y-Card {wallet.code}
offset integer No Número de registros a omitir al inicio de la lista de registros.
Valor predeterminado 0.
limit integer No Limite de registros a retornar.
Valor predeterminado 10.

Mensajes de error

Número Descripción
11551 No fue posible consultar la Y-Card
11552 El filtro Código de la Y-Card solo puede utilizarse por un WORK o CAY

Consultar saldos Y-Card

Objeto de respuesta JSON

{
    "wallet_balance":{
        "id":"00000000-0000-0000-0000-000000000000",
        "merchant": { Objeto user },
        "user_name":"Nombre del usuario",
        "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
        "account_number":"0000000000000",
        "currency_id":0,
        "currency_name":"Moneda",
        "currency_iso_code":"Código ISO de la moneda",
        "currency_symbol":"Símbolo de la moneda",
        "code":0,
        "balance":0,
        "balance_locked":0,
        "balance_available":0,
        "disabled":false,
        "creation_date":"1900-01-01T00:00:00",
        "modification_date":"1900-01-01T00:00:00"
    }
}

Consultar saldo de monedero de la Y-Card.

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/walletbalances/{wallet_balance_id}

Parámetros URL

Nombre Tipo Requerido Descripción
wallet_balance_id string(36) Si Identificador del saldo de la Y-Card wallet_balance.id

Mensajes de error

Número Descripción
11601 Y-Card no encontrada
11602 Identificador de la Y-Card inválido

Catálogos

Valores de catálogo requeridos para los llamadas al API

Tipos de transacciones

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/transactiontypes

Código Descripción
1 Bonificación (CAY)
2 Bonificación (WORK)
3 Retiro
6 Pago
14 Comisión de retiro *
16 Comisión de pago *
25 IVA *
27 Devolución Y-Card
28 Pago Y-Card
30 Promoción puntos Y-Card
31 Pago puntos Y-Card
46 Cancelación de IVA *
47 Cancelación de bonificación (CAY) *
48 Cancelación de bonificación (WORK) *
49 Cancelación de retiro (CAY) *
50 Cancelación de comisión de retiro (CAY) *
51 Cancelación de pago *
52 Cancelación de comisión de pago *
53 Cancelación de devolución Y-Card *
54 Cancelación de promoción puntos Y-Card *
55 Cancelación de pago Y-Card *
56 Cancelación de pago puntos Y-Card *

* Generadas por el sistema

Status de transacciones

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/transactionstatus

Código Descripción
1 Por aplicar
2 Aplicada
3 Rechazada
4 Cancelada

Monedas

Respuesta JSON arreglo de objetos currency

[
    {
        "id":0,
        "iso_code":"Código ido de la moneda",
        "symbol":"Símbolo de la moneda",
        "description": "Descripción"
    },
    {
        "id":0,
        "iso_code":"Código ido de la moneda",
        "symbol":"Símbolo de la moneda",
        "description": "Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/currencies

Código Código ISO Símbolo Descripción
1 MXN $ Pesos mexicanos
3 PTS Puntos

Tipos de Y-Card

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/wallettypes

Código Descripción
1 Monedero
2 Monedero promocional

Status de Y-Card

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/walletstatus

Código Descripción
1 Por autorizar
2 Autorizado
3 No autorizado
4 Eliminado

Diseños de Y-Card

Solicitud HTTP

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/walletdesigns

Código Descripción
1 Básico
2 Personalizado

Categorías de Y-Card

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/walletcategories

Código Descripción
2 Autos
9 Electrónicos
24 Bebés
36 Deportivos
46 Ropa, Zapatos y Accesorios
62 Alimentos y Bebidas
65 Deportes
75 Herramientas
83 Hogar y Cocina
94 Industria y Ciencia
100 Juegos y Juguetes
110 Libros
119 Mascotas
126 Salud y Belleza
133 Software
138 Videojuegos
147 Otros

Sub categorías de Y-Card

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/walletsubcategories

Parámetros QUERY

Nombre Tipo Requerido Descripción
wallet_category_id integer Si Identificador de la categoría de la Y-Card catalog.id
Código Descripción Categoría de Y-Card
3 Accesorios para Coche 2
4 Cuidado y Mantenimiento 2
5 Aceites y Fluidos 2
6 Partes y Refacciones para Coche 2
7 Herramientas 2
8 Motocicletas, Accesorios y Piezas 2
10 Televisión y Video 9
11 Audio y Equipos de Sonido 9
12 Celulares y Accesorios 9
13 Cámara y Fotografía 9
14 Navegación y GPS 9
15 Accesorios Electrónicos 9
16 Laptops 9
17 Tablets 9
18 Computadoras de Escritorio 9
19 Monitores 9
20 Componentes 9
21 Almacenamiento 9
22 Dispositivos para Redes 9
23 Accesorios 9
25 Mesa de Regalos de Bebé 24
26 Sillas de Coche 24
27 Carriolas y Cochecitos 24
28 Lactancia y Alimentación 24
29 Seguridad 24
30 Actividad y Entretenimiento 24
31 Recámara del Bebé 24
32 Cambio de Pañales 24
33 Chupones y Mordederas 24
34 Higiene y Cuidado 24
35 Portabebés 24
37 Fútbol 36
38 Fitness 36
39 Running 36
40 Ciclismo 36
41 Campismo 36
42 Golf 36
43 Box 36
44 Pesca 36
45 Deportes Acuáticos 36
47 Ropa 46
48 Zapatos 46
49 Accesorios 46
50 Joyería 46
51 Mujeres 46
52 Niñas 46
53 Niños 46
54 Bebé 46
55 Ropa 46
56 Zapatos 46
57 Accesorios 46
58 Joyería 46
59 Hombres 46
60 Bolsas y Maletas 46
61 Relojes 46
63 Alimentos 62
64 Cervezas, Vinos y Licores. 62
66 Fútbol 65
67 Fitness 65
68 Running 65
69 Ciclismo 65
70 Campismo 65
71 Golf 65
72 Box 65
73 Pesca 65
74 Deportes Acuáticos 65
76 Herramientas Manuales y Eléctricas 75
77 Accesorios de Herramientas 75
78 Ferretería 75
79 Electricidad 75
80 Protección y Seguridad 75
81 Almacenamiento y Organización 75
82 Equipamiento de Baños y Cocinas 75
84 Cocina 83
85 Electrodomésticos 83
86 Aspiración, Limpieza y Planchado 83
87 Blancos para el Hogar 83
88 Baño 83
89 Climatización y Calefacción 83
90 Decoración del Hogar 83
91 Iluminación 83
92 Arte y Manualidades 83
93 Cuidado del Hogar y Limpieza 83
95 Medición e Inspección 94
96 Seguridad 94
97 Limpieza y Saneamiento 94
98 Herramientas Industriales 94
99 Ferretería Industrial 94
101 Figuras de Acción 100
102 Muñecas 100
103 Juegos 100
104 Juguetes de Construcción 100
105 Artes y Manualidades 100
106 Juguetes para Bebés 100
107 Aire Libre y Deportes 100
108 Rompecabezas 100
109 Juguetes Electrónicos 100
111 Libros 110
112 Libros en Inglés 110
113 Infantil y Juvenil 110
114 Literatura y Ficción 110
115 Libros de Texto 110
116 Profesional y Técnico 110
117 Ciencia Ficción y Fantasía 110
118 Romance 110
120 Perros 119
121 Gatos 119
122 Aves 119
123 Animales Pequeños 119
124 Acuáticos 119
125 Reptiles y Anfibios 119
127 Belleza 126
128 Rasurado y Depilación 126
129 Perfumes y Fragancias 126
130 Equipo y Suministros Médicos 126
131 Baño e Higiene Personal 126
132 Cuidado de Bebés y Niños 126
134 Sistemas Operativos 133
135 Idiomas y Viajes 133
136 Antivirus y Seguridad 133
137 Gráficos y Diseño 133
139 PlayStation 4 138
140 PlayStation 3 138
141 Nintendo Switch 138
142 Nintendo 3DS 138
143 Wii U 138
144 Xbox One 138
145 Xbox 360 138
146 Preventas 138
148 Otros 147

Tipos de usuarios

Respuesta JSON arreglo de objetos catalog

[
    {
        "id":0,
        "description":"Descripción"
    },
    {
        "id":0,
        "description":"Descripción"
    }
]

Solicitud HTTP

GET https://www.yapsi.com.mx/sandbox/api/v1/catalogs/usertypes

Código Descripción
1 Usuario
2 Empresa
3 CAY

Objetos

Los siguientes objetos son retornados en los llamados al API

Objeto usuario

Objeto user

Ejemplo de objeto user

{
   "id":"00000000-0000-0000-0000-000000000000",
   "user_type_id":0,
   "user_type_name":"Tipo de usuario",
   "country_id":0,
   "country_name":"País",
   "state_id":0,
   "state_name":"Estado",
   "municipality_id":0,
   "municipality_name":"Municipio",
   "city_id":0,
   "city_name":"Ciudad",
   "nationality_id":0,
   "nationality_name":"Nacionalidad",
   "currency_id":0,
   "currency_name":"Moneda",
   "currency_iso_code":"Código ISO de la moneda",
   "currency_symbol":"Símbolo de la moneda",
   "banorte_provider_status_id":0,
   "banorte_provider_status_name":"Status de proveedor Banorte",
   "banorte_employee_status_id":0,
   "banorte_employee_status_name":"Status de empleado Banorte",
   "business_name":"Nombre del negocio",
   "first_name":"Primer nombre",
   "second_name":"Segundo nombre",
   "fathers_last_name":"Apellido paterno",
   "mothers_last_name":"Apellido materno",
   "tax_id_number":"RFC",
   "personal_id_code_number":"CURP",
   "personal_message":"Mensaje personal",
   "gender_id":0,
   "gender_name":"Genero",
   "marital_status_id":0,
   "marital_status_name":"Estado civil",
   "marital_regime_id":0,
   "marital_regime_name":"Régimen matrimonial",
   "occupation_id":0,
   "occupation_name":"Ocupación nacional",
   "education_level_id":0,
   "education_level_name":"Nivel educativo",
   "professional_title_id":0,
   "professional_title_name":"Profesión",
   "birthdate":"1900-01-01T00:00:00",
   "picture":"https://www.yapsi.com.mx/.../avatar.jpg",
   "account_number":"0000000000000",
   "complete_profile":false,
   "complete_expedient":false,
   "active_payroll_module":false,
   "active_stamp_payroll_module":false,
   "active_api_keys":false
}

Objeto transacción

Objeto transaction

Ejemplo de objeto transaction

{
  "id":"00000000-0000-0000-0000-000000000000",
  "transaction_type_id":0,
  "transaction_type_name":"Tipo de transacción",
  "transaction_status_id":0,
  "transaction_status_name":"Status de transacción",
  "currency_id":0,
  "currency_name":"Moneda",
  "currency_iso_code":"Código ISO de la moneda",
  "currency_symbol":"Símbolo de la moneda",
  "amount":0,
  "reference":"Referencia",
  "comments":"Comentarios",
  "user_name":"Nombre de usuario",
  "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
  "user": { Objeto user },
  "operator_name":"",
  "branch_office_name":"",
  "creation_date":"1900-01-01T00:00:00",
  "confirmation_date":"1900-01-01T00:00:00",
  "rejection_date":"1900-01-01T00:00:00"
}

Objeto Y-Card

Objeto wallet

Ejemplo de objeto wallet

{
   "id":"00000000-0000-0000-0000-000000000000",
   "wallet_type_id":0,
   "wallet_type_name":"Tipo de monedero",
   "wallet_status_id":0,
   "wallet_status_name":"Status de monedero",
   "wallet_design_id":0,
   "wallet_design_name":"Diseño",
   "wallet_category_1_id":0,
   "wallet_category_1_name":"Categoría de monedero",
   "wallet_sub_category_1_id":0,
   "wallet_sub_category_1_name":"Sub categoría de monedero",
   "wallet_category_2_id":0,
   "wallet_category_2_name":"Categoría de monedero",
   "wallet_sub_category_2_id":0,
   "wallet_sub_category_2_name":"Sub categoría de monedero",
   "currency_id":0,
   "currency_name":"Moneda",
   "currency_iso_code":"Código ISO de la moneda",
   "currency_symbol":"Símbolo de la moneda",
   "code":0,
   "name":"Nombre del monedero",
   "display_name":true,
   "text_color":"000000",
   "background_color":"000000",
   "description":"Descripción del monedero",
   "terms_conditions":"Términos y condiciones",
   "privacy_policies":"Políticas de privacidad",
   "url_terms_conditions":"URL de términos y condiciones",
   "url_privacy_policies":"URL de políticas de privacidad",
   "url_logotype":"https://www.yapsi.com.mx/sandbox/.../logotipo.jpg",
   "url_image":"https://www.yapsi.com.mx/sandbox/.../imagen.jpg",
   "url_redirect":"URL de redirección",
   "points_expiration_date":"1900-01-01T00:00:00",
   "wallet_expiration_date":"1900-01-01T00:00:00",
   "creation_date":"1900-01-01T00:00:00",
   "modification_date":"1900-01-01T00:00:00",
   "discharge_date":"1900-01-01T00:00:00",
   "owner":{ Objeto user },
   "merchant":{ Objeto user },
   "wallet_balance":{ Objeto wallet_balance },
   "quantity_wallet_balances":0
}

Código de la Y-Card

El código de la Y-Card, es el código con el que el Work o CAY identificará su Y-Card.
Este código corresponde a la propiedad wallet.code y es referenciado en el API como {wallet_code}.

Objeto saldo Y-Card

Ejemplo de objeto wallet_balance

{
   "id":"00000000-0000-0000-0000-000000000000",
   "merchant": { Objeto user },
   "user_name":"Nombre del usuario",
   "user_picture":"https://www.yapsi.com.mx/.../avatar.jpg",
   "account_number":"0000000000000",
   "currency_id":0,
   "currency_name":"Moneda",
   "currency_iso_code":"Código ISO de la moneda",
   "currency_symbol":"Símbolo de la moneda",
   "code":0,
   "balance":0,
   "balance_locked":0,
   "balance_available":0,
   "disabled":false,
   "creation_date":"1900-01-01T00:00:00",
   "modification_date":"1900-01-01T00:00:00"
}

Objeto wallet_balance

Número de la Y-Card

El número de la Y-Card, es el número con el que el Usuario o Work identificará su Y-Card.
Este número corresponde a la propiedad wallet_balance.code y es referenciado en el API como {wallet_balance_code}.

Ejemplo de objeto catalog

{
   "id":0,
   "description": "Descripción"
}

Objeto catalog

Objeto moneda

Ejemplo de objeto currency

{
   "id":0,
   "iso_code":"Código ido de la moneda",
   "symbol":"Símbolo de la moneda",
   "description": "Descripción"
}

Objeto currency