REST API Reference

Accounts
Management API

Professional REST API for managing billing accounts, products, contacts, and addresses at Yocon Móvil.

7

Endpoints

v1.0

API Version

REST

Architecture

JSON

Format

Available Endpoints

GET

All Accounts

/accounts

POST

Create Account

/accounts

PATCH

Update Account

/accounts

PATCH

Update Status

/accounts/{id}/status

POST

Upgrade Account

/accounts/upgrade

GET

Activate Account

/accounts/{id}/activate

DELETE

Delete Account

/accounts/{id}

Security

Authentication

All API requests require the x-api-key header.

API Key Header

x-api-key MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3

✓ Required on all requests

✓ Passed in request header

Example Header

x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3
Content-Type: application/json

GET

api/accounts

Retrieve all billing accounts. No request body required.

GET request — no body needed. Pass the required header and receive the full list of accounts.

Request Headers

Header	Value
x-api-key	your-api-key	Required

cURL Example

curl --location \
  'https://apis.yoconmovil.mx/api/accounts' \
  --header 'x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3'

Sample Response

{
  "data": [
    {
      "billingAccountNumber": "65412222541",
      "billingAccountName": "RESTAURANTE X",
      "accountProducts": [ /* ... */ ]
    }
  ],
  "total": 1
}

POST

api/accounts

Create a new billing account with products, contacts, and addresses.

Request Headers

Header	Value
Content-Type	application/json
x-api-key	your-api-key	Required

Request Body

{
  "billingAccountNumber": "65412222541",
  "billingAccountName": "RESTAURANTE X",
  "accountProducts": [
    {
      "productCode": "PN-1873",
      "productInstanceId": "000000105",
      "productInstanceStatus": "active",
      "purchaseDate": "2026-03-19T17:32:32Z",
      "productRelatedInformation": {
        "contacts": [
          {
            "type": "main",
            "name": "Edgardo C",
            "phone": "55515390",
            "email": "correo1@mail.com"
          },
          {
            "type": "alternate",
            "name": "Juan Ma",
            "phone": "5553203101",
            "email": "correo2@mail.com"
          }
        ],
        "addresses": [
          {
            "type": "serviceAccount",
            "street": "Av. Constituyentes",
            "number": 450,
            "state": "Ciudad de Mexico",
            "municipality": "municipalidad",
            "country": "Mexico",
            "postalCode": "55789",
            "location": {
              "lat": 19.352,
              "lon": -99.23
            }
          }
        ]
      }
    }
  ]
}

cURL Example

curl --location \
  'https://apis.yoconmovil.mx/api/accounts' \
  --header 'x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "billingAccountNumber": "65412222541",
  "billingAccountName": "RESTAURANTE X",
  "accountProducts": [
    {
      "productCode": "PN-1873",
      "productInstanceId": "000000105",
      "productInstanceStatus": "active",
      "purchaseDate": "2026-03-19T17:32:32Z",
      "productRelatedInformation": {
        "contacts": [...],
        "addresses": [...]
      }
    }
  ]
}'

PATCH

api/accounts

Update an existing billing account's data including contacts and addresses.

Request Headers

Header	Value
Content-Type	application/json
x-api-key	your-api-key	Required

Request Body

{
  "billingAccountNumber": "65412222541",
  "billingAccountName": "testing name",
  "accountProducts": [
    {
      "productCode": "PN-1873",
      "productInstanceId": "000000105",
      "productInstanceStatus": "active",
      "purchaseDate": "2026-03-19T17:32:32Z",
      "productRelatedInformation": {
        "contacts": [
          {
            "type": "contact",
            "name": "Updated Name",
            "phone": "55515390",
            "email": "updated@mail.com"
          }
        ],
        "addresses": [
          {
            "type": "service Account",
            "street": "Av. Updated",
            "number": 123,
            "state": "Ciudad de Mexico",
            "municipality": "municipalidad",
            "country": "Mexico",
            "postalCode": "55789",
            "location": {
              "lat": 19.352,
              "lon": -99.23
            }
          }
        ]
      }
    }
  ]
}

cURL Example

curl --location --request PATCH \
  'https://apis.yoconmovil.mx/api/accounts' \
  --header 'x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3' \
  --header 'Content-Type: application/json' \
  --data-raw '{...}'

PATCH

api/accounts/{billingAccountNumber}/status

Update the status of a billing account (e.g. reactivated, suspended).

Request Headers

Header	Value
Content-Type	application/json
x-api-key	your-api-key	Required

Path Parameter

Parameter	Type
billingAccountNumber	string	Required

Request Body

{
  "status": "reactivated",
  "statusChangedAt": "2026-03-31T17:32:32Z"
}

cURL Example

curl --location --request PATCH \
  'https://apis.yoconmovil.mx/api/accounts/65412222541/status' \
  --header 'x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "reactivated",
  "statusChangedAt": "2026-03-31T17:32:32Z"
}'

POST

api/accounts/upgrade

Add a new digital menu product to an existing billing account.

Upgrades an existing account by appending a new menú digital product (e.g. PN-1875) without replacing existing products.

Request Headers

Header	Value
Content-Type	application/json
x-api-key	your-api-key	Required

Body Fields

Field	Type	Description
billingAccountNumber	string	Existing account number	Required
billingAccountName	string	Account display name	Required
accountProducts	array	New product(s) to add	Required
productCode	string	e.g. PN-1875	Required
productInstanceId	string	Unique product instance ID	Required
productInstanceStatus	string	active / inactive
purchaseDate	ISO 8601	Date of purchase	Required

Request Body

{
  "billingAccountNumber": "9006829",
  "billingAccountName": "RESTAURANTE EXAMPLE",
  "accountProducts": [
    {
      "productCode": "PN-1875",
      "productInstanceId": "000000106",
      "productInstanceStatus": "active",
      "purchaseDate": "2026-04-27T16:37:32Z",
      "productRelatedInformation": {
        "contacts": [
          {
            "type": "main",
            "name": "Main",
            "phone": "4187526325",
            "email": "correo@mail.com"
          },
          {
            "type": "alternate",
            "name": "Sec",
            "phone": "4187526320",
            "email": "correo2@mail.com"
          }
        ],
        "addresses": [
          {
            "type": "Servicio",
            "street": "20 de Noviembre",
            "number": 1111,
            "state": "Nuevo Leon",
            "municipality": "Monterrey",
            "country": "Mexico",
            "postalCode": "64800",
            "location": {
              "lat": 25.6688,
              "lon": -100.2879
            }
          }
        ]
      }
    }
  ]
}

cURL Example

curl --location \
  'https://apis.yoconmovil.mx/api/accounts/upgrade' \
  --header 'x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "billingAccountNumber": "9006829",
  "billingAccountName": "RESTAURANTE EXAMPLE",
  "accountProducts": [
    {
      "productCode": "PN-1875",
      "productInstanceId": "000000106",
      "productInstanceStatus": "active",
      "purchaseDate": "2026-04-27T16:37:32Z",
      "productRelatedInformation": {
        "contacts": [...],
        "addresses": [...]
      }
    }
  ]
}'

The billingAccountNumber must match an existing account.

GET

api/accounts/{billingAccountNumber}/activate

Activate a billing account. No request body required.

No request body needed — only the billing account number in the URL path and the API key header.

Request Headers

Header	Value
x-api-key	your-api-key	Required

Path Parameter

Parameter	Type
billingAccountNumber	string	Required

cURL Example

curl --location \
  'https://apis.yoconmovil.mx/api/accounts/65412541/activate' \
  --header 'x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3'

DELETE

api/accounts/{billingAccountNumber}

Delete a billing account with a reason (soft delete).

Soft delete — account data is retained for auditing but will no longer be accessible.

Request Headers

Header	Value
Content-Type	application/json
x-api-key	your-api-key	Required

Path Parameter

Parameter	Type
billingAccountNumber	string	Required

Request Body

{
  "reason": "Billing",
  "billingAccountNumber": "78451120"
}

cURL Example

curl --location --request DELETE \
  'https://apis.yoconmovil.mx/api/accounts/56566566dsds5' \
  --header 'x-api-key: MBVwGvqSA2j2myLMoxMSGA3xjhgf54kshdgslAVpRf3' \
  --header 'Content-Type: application/json' \
  --data '{
  "reason": "Billing",
  "billingAccountNumber": "78451120"
}'

AccountsManagement API

Authentication

Accounts
Management API