NAV Navbar

Introduction

Welcome to YAPSI developer API.

With our API you will be able to integrate grow your projects in different forms, by accepting money in a secure, fast and low-cost way.

In order to start, it is necessary to create a test account inside our Sandbox in the following link https://www.yapsi.com.mx/sandbox/frontend/registro.aspx

API Keys

To obtain the API Keys, it is necessary to open the following link: https://www.yapsi.com.mx/sandbox/frontend and press click on MI CUENTA/ Llaves API and consult the trade identifier {merchant_id} and generate the private key {private_key}.

Sandbox Users

To register a test user account, it’snecessary to go to https://www.yapsi.com.mx/sandbox/frontend and register the user's accounts in the menu option EMPRESA / Usuarios (Sandbox).

The official API documentation is in the following link https://www.beyapsi.com/docs/api

General Considerations

Objeto de respuesta JSON exitosa

{
  "objeto": { ... }
}

Objeto de respuesta JSON de error

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

Consider as a general rule that the endpoints will respond in JSON format unless for use cases where the opposite is specified.

If the request is done with invalid values inside within its parameters, it would be answered with a state code HTTP 4xx and an answer in JSON format with the error object.

If the request is not processed correctly, it will respond with a state code HTTP 5xx and an answer in JSON format.

If the request is processed correctly, it will respond with a state code HTTP” 2xx and an answer in JSON format.

Sandbox Base URL

The Sandbox Base URL that must be used for calling the endpoints is the following.

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

Authentication

To obtain access to our API is necessary to obtain a {session_token} with his own trade identifier {merchant_id} and a private key {private_key}.

For all the endpoints where it is specified, the API must receive the session token through the headline authorization.

Authorization: bearer {session_token}

For obtaining API keys go to Introducción. For obtaining a token session go to: Llaves API / Validar

API keys

Validate API keys

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
    }
  }
}

Validate the API keys formed by the trade identificatory {merchant_id} and the private sandbox key {private_key} to obtain a session token {session_token}.

HTTP request

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

BODY parameters (x-www-form-urlencoded)

Name Type Length Description
merchant_id string 36 Trade identifier
private_key string 36 Private key

Error messages

Number Description
11251 API keys invalidated, canceled or revoked
11252 It was not possible to consult the commerce
11253 It was not possible to generate session for the commerce

Consult API keys

Objeto de respuesta JSON

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

Once consulted the API keys, the trade identifier {merchant_id} and the private key of the commerce {private_key}.

HTTP request

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

QUERY Parameters

Without parameters

Error messages

Number Description
11301 It was not possible to consult the API keys

Create / Renew API keys

Objeto de respuesta JSON

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

Create or renew the private key of Sandbox

HTTP Resquest

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

Error messages

Number Description
11351 It was not possible to consult API keys
11352 API keys inactive, it is not possible to generate or renew it.

Transactions

Create transactions

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"
    }
}

Create operation of various types (catalog) that are carried out between WORKs and YAPSI Users, that need the use of money in order to defray the costs of products and services. It implies affectation of the available balances of the Y-Cards.

HTTP Request

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

BODY Parameters (x-www-form-urlencoded)

Name Type Length Description
transaction_type_id Integer Yes Type of transition (ver catálogo).
currency_id Integer Yes Type of currency (ver catálogo).
account_number string(13) Yes YAPSI account number of the beneficiary (user.account_number).
amount numeric Yes Quantity of the transaction.
comments string(50) No Comments of the transaction.
wallet_code Integer No Y-Card code (wallet.code)
required for the types of transactions:
27 = Return Y-Card
30 = Y-Card promotion points

Error messages

Number Description
4101 It is not possible to create the transaction.
4102 Account number not required for the type of the transaction specified.
4103 Invalid account number.
4104 The account number cannot be the user account number of WORK or CAY.
4105 Type of transaction not allowed for the user account.
4112 There is no money in the requested currency.
4113 There is insufficient money for the request currency.
4119 The operator provided does not belong to the user account or is inactive.
4120 The branch office assonated to the operator is inactive
4121 It was not possible to consult the withdrawal commission.
4122 The amount to digitalize must be bigger than the amount of the commission.
4123 It was not possible to consult the withdrawal policies.
4124 The minimum day policy for the first withdrawal is not met.
4125 The minimum money amount policy is not met for the withdrawal.
4126 Invalid currency to calculate the minimum money for a withdrawal.
4127 It was not possible to calculate the commission of the transaction.
4128 Insufficient amount of money for the charge of the commission.
4131 It was not possible to consult the charge commission.
4132 The amount of money must be bigger than the amount of the commission.
4133 Y-Card balance is required for the type of transaction. 
4134 Y-Card balance is not required for the type of transaction.
4135 Y-Card balance is not found.
4136 Y-Card balance cannot be affected by this user account.
4137 The currency of the balance of the Y-Card is different from the currency of the transaction.
4138 It was not possible to consult the Y-Card balance.
4139 Available balance insufficient in the Y-Card balance.
4140 It was not possible to relate the transaction with the Y-Card balance.
15017 Y-Card code required.
15018 Y-Card code is not required for the specified transaction.
15019 Invalid Y-Card code.
15020 Y-Card does not belong to the user account.
15021 The Y-Card is not authorized.
15022 The Y-Card currency is different from the specified currency.
15023 The Y-Card points expired; it is not possible to register the transaction.
15024 Y-Card expired, not possible to register the transaction.
15025 For the specified transaction, it is required the currency 3 = points.
15026 The currency 3= points are invalid for the type of transaction.

Consult Transactions

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"
    }
}

It recovers one specific transaction by his identificatory (transaction.id).

HTTP Request

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

URL Parameters

Name Type Required Description
transaction_id string(36) Yes Transaction identifier transaction.id

List transactions

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
}

It obtains a transaction list.

HTTP Request

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

Parámetros QUERY

Name Type Required Description
creation_from date Yes Creation date since...
creation_to date Yes Creation date until...
transaction_type_id integer No Type of transaction.
transaction_status_id integer No Transaction status.
operador_id string(32) No Operator ID; only for WORKs and CAY.
branch_office_id string(32) No Branch office ID; only for WORKs and CAYs.
reference string(20) No Transaction reference.
comments string(50) No Transaction comments.
account_number string No Account number of YAPSI beneficiary.
offset integer No Number of registers to omit at the beginning of the list (default = 0).
limit integer No Limit of registers to return (default = 10).
sort_by string(50) No It can contain one of the following values: reference, transaction_status_name, transaction_type_name, amount, user_name, creation date.

Cancel transactions

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"
    }
}

Create a transaction that will cancel or apply reverse to a wrong transaction.

HTTP Request

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

Parámetros URL

Name Type Required Description
transaction_id string(36) Yes Transaction ID transaction.id

BODY parameters (x-www-form-urlencoded)

Name Type Requiered Description
comments string(50) No Transactions comments

Error messages

Number Description
4350 Transaction ID invalid.
4351 The user is not related to the transaction.
4352 The transaction about to cancel is not appliqued.
4353 Invalid type of transaction.
4354 Error when consulting the total balance of the transaction about to cancel.
4355 Error when consulting the balance available of the transaction about to cancel.
4356 Available balance insufficient.
4357 Error when consulting Y-Card balance.
4358 Available Y-Card balance insufficient.
4359 Error when registering the cancellation, call YAPSI.
4360 Error when registering additional transactions (taxes and commissions) YAPSI.
4361 Error when relating the transaction of cancelation with the Y-Card.
4362 Error when consulting the beneficiary.
4363 Error when registering the cancelation message.

Transactions tokens

Validate transactions tokens

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"
    }
}

Apply a transaction token to a WORK or a CAY

HTTP Request

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

BODY parameters (x-www-form-urlencoded)

Name Type Required Description
transaction_token string(15) Yes Transaction token
comments string(50) No Transaction comments
transaction_type_id int No Type of transaction to apply.
The transaction blanks _type_id, currency_id and amount, should be entered only when is wish to validate the type of transaction, the currency and the balance of the token to apply.
If the type of transaction, the currency, and the balance would not match, the transaction token would not apply and would cancel itself.
The only type of transactions accepted are the following:
3 = withdrawal
6 = payment
28 = Y-Card payment
31 = Payment by Y-Card points.
currency_id int No The currency of the transaction token to be applied.
The transaction_type_id, currency_id, and amount fields must be provided only when is wished to validate the type of the transaction, the currency and the transaction token amount to be applied.
If the transaction type, currency and amount will not match, the transaction token is not applied and canceled.
amount numeric No Amount of the transaction token to be applied.
It must be provided together with the transaction_type_id field only when is wished to validate the type of the transaction and the amount of the transaction token to be applied.
If the transaction type, currency and amount will not match, the transaction token is not applied and canceled.

Error messages

Number Description
6201 It was not possible to validate the transaction token.
6202 The token does not exist.
6203 It is not possible to process the transaction related to the token.
6204 The token cannot be processed with this user account.
6205 It is not possible to process a token with a different currency from the local currency from the user.
6206 The token has expired.
6207 The token has been already used.
6208 It is not possible to consult the withdrawal commission.
6209 The balance of the withdrawal commission is bigger than the balance of the token.
6210 It is not possible to register the withdrawal commission.
6211 It is not possible to apply the related transactions.
6215 Invalid type of transaction, only the types 3 = withdrawal, 6 = payment, 28 = Y-Card Payment and 30 = payment with Y-Card points are accepted.
6216 Type of transaction, currency, and balance are required.
6217 type of transaction does not match to the type of token transaction.
6218 Currency does not match with token currency.
6219 Balance does not correspond to the token balance.

Consult a token transaction

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"
    }
}

Consult a token transaction.

HTTP Request

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

QUERY parameters

Name Type Required Description
transaction_token string(15) Yes Transaction token

Error messages

Number Description
6251 Error when consulting the transaction token.
6252 The token does not exist.
6253 The token has bees already used.
6254 The token has expired.

Y-Cards

Create 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
    }
}

Registering a public Y-Card for a WORK or CAY.

In the Sandbox, the register Y-Cards would be authorized automatically so they can be saved by the user account of tests.

In the sandbox of Producción, the Y-Cards that have been registered, will be double checked and authorized by YAPSI only when they respect the design agreement.

HTTP Request

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

BODY parameters (x-www-form-urlencoded)

Name Type Required Description
wallet_type_id integer Yes Y-Card type (see catalog)
wallet_design_id integer Yes Design of the Y-Card (see catalog)
wallet_category_1_id integer Yes Category 1 of the Y-Card (see catalog)
wallet_sub_category_1_id integer Yes Subcategory 1 of the Y-Card (see catalog)
wallet_category_2_id integer No Category 2 of the Y-Card (see catalog)
Default value 0.
wallet_sub_category_2_id integer No Sub Category 2 de la Y-Card (see catalog)
Default value 0.
currency_id integer Yes Currency (see catalog)
name string(70) Yes Name
display_name boolean Yes Show name
text_color string(6) Yes Text color
background_color string(6) Yes Background color
description string(1000) No Description
terms_conditions string No Terms and conditions
privacy_policies string No Privacy policies
url_terms_conditions string(255) No Terms and conditions URL
url_privacy_policies string(255) No Privacy policies URL
url_redirect string(255) No Redirection URL
points_expiration_date datetime No Expire date of the points.
Required when the currency is 3 = points.
Upon expiration of this date, an expiration movement of Y-Card points will be recorded automatically.
wallet_expiration_date datetime No The effective date of the Y-Card.
Default value 9999/12/30.
When this date is fulfilled, the Y-Card cannot be rewarded.

Error messages

Number Desscription
16151 The category/subcategory 1 of the Y-card is invalid.
16152 The category/subcategory 2 of the Y-Card is invalid.
16153 It wasn´t possible to register the Y-Card, check the information and try again.
16154 The expiration date of the Y-Card must be bigger than today´s date.
16155 The expiration date of the points must be bigger than today´s date.
16156 The expiration date of the points must be smaller or equal than the effective date of the Y-Card.

Edit Y-Cards

Edit a public Y-Card of a Work or a Cay.

HTTP Request

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

URL parameters

Name Type Required Description
wallet_id string(36) Yes Y-Card identifier wallet.id

BODY parameters (x-www-form-urlencoded)

Name Type Required Description
wallet_design_id integer Yes Design of the Y-Card (see catalog)
wallet_category_1_id integer Yes Category 1 of the Y-Card (see catalog)
wallet_sub_category_1_id integer Yes Sub Category 1 of the Y-Card (see catalog)
wallet_category_2_id integer No Category 2 of the Y-Card (see catalog)
Default value 0.
wallet_sub_category_2_id integer No Sub Category 2 of the Y-Card (see catalog)
Default value 0.
name string(70) Yes Name
display_name boolean Yes Show name
text_color string(6) Yes Text color
background_color string(6) Yes Background color
description string(1000) No Description
terms_conditions string No Terms and conditions
privacy_policies string No Privacy policies
url_terms_conditions string(255) No Terms and conditions URL
url_privacy_policies string(255) No Privacy policies URL
url_redirect string(255) No Redirect URL
points_expiration_date datetime No The effective date of the points.
Required when the currency is 3 = Points.
Upon expiration of this date, an expiration movement of Y-Card points will be recorded automatically.
wallet_expiration_date datetime No The effective date of the Y-Card.
Default value 9999/12/30.
When this date is fulfilled, the Y-Card cannot be rewarded.

Error messages

Number Description
16251 Invalid Y-Card identifier.
16252 The Y-Card does not belong to the user.
16253 Category / Sub Category 1 of the Y-Card is invalid.
16254 Category / Sub Category 2 of the Y-Card is invalid.
16255 It was not possible to update the Y-Card, review the information capture and try again.
16256 Status of the Y-Card other than Authorize, it is not possible to edit.
16257 The effective date of the Y-Card must be greater than the current date.
16258 The effective date of the points must be greater than the current date.
16259 The effective date of the points must be less than or equal to the effective date of the Y-Card.

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
    }
}

Update the logo of a Y-Card.

HTTP Request

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

URL parameters

Name Type Required Description
wallet_id string(36) Yes Y-Card identifier wallet.id

BODY parameters (form-data)

Name Type Required Description
logotype binary Yes Y-Card logo

Error messages

Number Description
16301 Identifier of the invalid Y-Card.
16302 The Y-Card does not belong to the user.
16303 It is not possible to update the logo of a canceled Y-Card.
16304 It was not possible to keep the logo.
16305 It was not possible to update the logo.

Update Y-Cards images

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
    }
}

Update the Y-Card image.

HTTP Request

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

URL parameters

Name Type Required Description
wallet_id string(36) Yes Y-Card identifier wallet.id

BODY parameters (form-data)

Name Type Required Description
image binary Yes Y-Card image

Error messages

Number Description
16351 Identifier of the invalid Y-Card.
16352 The Y-Card does not belong to the user.
16353 It is not possible to update the image of a canceled Y-Card.
16354 It was not possible to save the image.
16355 It was not possible to update the image.

Delete Y-Cards

Respuesta vacía

Eliminate a Y-Card of a Work or a CAY

HTTP Request

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

URL parameters

Name Type Required Description
wallet_id string(36) Yes Y-Card identifier wallet.id

Error messages

Number Description
16401 Identifier of the card And invalid.
16402 The Y-Card does not belong to the user.
16403 Status of the Y-Card is different from Authorizing or Authorized.
16404 The Y card cannot be deleted because it is related to users.
16405 It was not possible to cancel the Y-Card.

Consult 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
    }
}

Consult a specific Y-Card for a WORK or a CAY throughout a Y-Card identifier.

HTTP Request

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

URL parameters

Name Type Required Description
wallet_id string(36) Yes Y-Card identifier wallet.id

Error messages

Number Description
16101 Invalid Y-Card identifier

List 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
}

List Y-Cards of the Work or CAY

HTTP Request

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

QUERY parameters

Name Type Required Description
wallet_status_id integer No Status of the Y-Card (see catalog)
wallet_type_id integer Yes Type of the Y-Card (see catalog)
wallet_design_id integer Yes Design of the Y-Card (see catalog)
wallet_category_1_id integer Yes Category 1 of the Y-Card (see catalog)
wallet_sub_category_1_id integer Yes Sub Category 1 of the Y-Card (see catalog)
currency_id integer Yes Currency see catalog
code integer No Y-Card Code
name string(50) No Name of the Y-Card
creation_from date No Date of creation from
creation_to date No Date of creation up
wallet_balance_code integer No Number of the Y-Card wallet_balance.code
offset integer No Number of records to be omitted at the beginning of the list of records.
Default value 0.
limit integer No Limit of records to return.
Default value 10.

Error messages

Number Description
16101 Invalid Y-Card identifier

Balance and Y-Card list

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
}

List the balances of the Y-Cards.

HTTP Resquest

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

QUERY parameters

Name Type Required Description
wallet_code integer No Y-Card Code {wallet.code}
offset integer No A number of records to be omitted at the beginning of the list of records.
Default value 0.
limit integer No Limit of records to return.
Default value 10.

Error messages

Number Description
11551 It was not possible to consult the Y-Card.
11552 The Code filter of the Y-Card can only be used by a WORK or CAY.

Consult Y-Card balances

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"
    }
}

Consult balance of the Y-Card.

HTTP Request

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

URL parameters

Name Type Required Description
wallet_balance_id string(36) Yes Y-Card balance identifier wallet_balance.id

Error messages

Number Description
11601 Y-Card not found.
11602 Y-Card identifier invalid.

Catalogs

See catalogs required for the API calls.

Type of transactions

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

Error messages

Código Descripción
1 Bonus (CAY)
2 Bonus (WORK)
3 Retirement
6 Payment
14 Withdrawal commission *
16 Payment commission *
25 IVA *
27 Return Y-Card
28 Payment Y-Card
30 Promotion Y-Card points
31 Payment points Y-Card
46 VAT Cancellation *
47 Cancellation of the bonus (CAY) *
48 Cancellation of the bonus (WORK) *
49 Withdrawal of withdrawal (CAY) *
50 Cancellation of withdrawal commission (CAY) *
51 Cancellation of payment *
52 Cancellation of payment commission *
53 Return cancellation Y-Card *
54 Cancellation of promotion points Y-Card *
55 Payment cancellation Y-Card *
56 Cancellation of payment points Y-Card *

* Generated by the system

Transaction status

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

Error messages

Code Description
1 To apply
2 Already applied
3 Rejected
4 Canceled

Currencies

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"
    }
]

HTTP Request

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

Code ISO Code Symbol Description
1 MXN $ Mexican pesos
3 PTS Points

Y-Card types

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

Error messages

Code Description
1 Purse
2 Promotional purse

Y-Card status

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

Error messages

Code Description
1 About to authorize
2 Authorized
3 Not authorized
4 Deleted

Y-Card Designs

HTTP Resquest

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

Error messages

Code Description
1 Basic
2 Personalized

Y-Card Categories

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

Error messages

Code Description
2 Cars
9 Electronic
24 Babies
36 Sports
46 Clothing, Shoes, and Accessories
62 Food and drinks
65 sports
75 Tools
83 Home and Kitchen
94 Industry and Science
100 Games and toys
110 books
119 Pets
126 Health and Beauty
133 software
138 Video game
147 Others

Y-Card subcategories

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

QUERY parameters

Name Type Required Description
wallet_category_id integer Yes Y-Card category identifier catalog.id

Error messages

Code Description Y-Card category
3 Car Accessories 2
4 Care and maintenance 2
5 Oils and Fluids 2
6 Parts and Accessories for Car 2
7 Tools 2
8 Motorcycles, Accessories and Parts 2
10 Television and Video 9
11 Audio and Sound Equipment 9
12 Cell phones and accessories 9
13 Camera and Photography 9
14 Navigation and GPS 9
15 Electronic accessories 9
16 Laptops 9
17 Tablets 9
18 Desktop Computers 9
19 Monitors 9
20 Components 9
21 Storage 9
22 Devices for Networks 9
23 accessories 9
25 Baby Gift Table 24
26 Car seats 24
27 Carriolas and Strollers 24
28 Breastfeeding and Feeding 24
29 Security 24
30 Activity and Entertainment 24
31 Baby Bedroom 24
32 Diapering 24
33 Chupones and Mordederas 24
34 Hygiene and Care 24
35 Baby carriers 24
37 Football 36
38 Fitness 36
39 Running 36
40 Cycling 36
41 Camping 36
42 Golf 36
43 Box 36
44 Fishing 36
45 Watersports 36
47 Clothing 46
48 Shoes 46
49 accessories 46
50 Jewelry 46
51 Women 46
52 Girls 46
53 Children 46
54 Baby 46
55 Clothing 46
56 Shoes 46
57 accessories 46
58 Jewelry 46
59 men's 46
60 Bags and Suitcases 46
61 Watches 46
63 Foods 62
64 Beers, Wines and Liqueurs. 62
66 Football 65
67 Fitness 65
68 Running 65
69 Cycling 65
70 Camping 65
71 Golf 65
72 Box 65
73 Fishing 65
74 Watersports 65
76 Manual and Electrical Tools 75
77 Tools Accessories 75
78 Hardware store 75
79 Electricity 75
80 Protection and Security 75
81 Storage and Organization 75
82 Bathroom and Kitchens equipment 75
84 Kitchen 83
85 Home appliances 83
86 Aspiration, Cleaning and Ironing 83
87 Targets for Home 83
88 Bathroom 83
89 Air conditioning and heating 83
90 Home decor 83
91 illumination 83
92 Arts and Crafts 83
93 Home Care and Cleaning 83
95 Measurement and Inspection 94
96 Security 94
97 Cleaning and Sanitation 94
98 Industrial Tools 94
99 Industrial hardware 94
101 Action figures 100
102 dolls 100
103 Games 100
104 Construction Toys 100
105 Arts and Crafts 100
106 Toys for babies 100
107 Outdoors and Sports 100
108 Puzzle 100
109 Electronic Toys 100
111 books 110
112 Books in English 110
113 Children and Youth 110
114 Literature and Fiction 110
115 Textbooks 110
116 Professional and Technical 110
117 Science Fiction and Fantasy 110
118 Romance 110
120 Dogs 119
121 Cats 119
122 Birds 119
123 Small animals 119
124 Aquatic 119
125 Reptiles and amphibians 119
127 Beauty 126
128 Shaving and Depilation 126
129 Perfumes and Fragrances 126
130 Medical Equipment and Supplies 126
131 Bath and Personal Hygiene 126
132 Care of Babies and Children 126
134 Operating systems 133
135 Languages ​​and Travel 133
136 Antivirus and Security 133
137 Graphics and Design 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 Presales 138
148 Others 147

Users types

Respuesta JSON arreglo de objetos catalog

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

HTTP Request

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

Error messages

Code Description
1 User
2 Wrok
3 CAY

Objects

The following objects are returned in API calls.

User object

User object

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
}

Object transactions

Object 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"
}

Y-Card Oject

Object wallet_balance

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
}

Y-Card object

The Y-Card number is the number which that the User or Work identify their Y-Card.
This number corresponds to wallet.code and is found in the API as {wallet_code}.

Y-Card balance object

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

Y-Card number

The Y-Card number is the number which that the User or Work identify their Y-Card.
This number corresponds to wallet_balance.code and is found in the API as {wallet_balance_code}.

Catalog object

Ejemplo de objeto catalog

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

Objeto catalog

Currency object

Ejemplo de objeto currency

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

Currency object