POST api/Login

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Password	string	None.
UserName	string	None.
Latitud	string	None.
Longitud	string	None.
CallingIPAddress	string	None.
AppVersionNumber	string	None.
TerminalSerialNumber	string	None.
securityToken	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Password": "sample string 1",
  "UserName": "sample string 2",
  "Latitud": "sample string 3",
  "Longitud": "sample string 4",
  "CallingIPAddress": "sample string 5",
  "AppVersionNumber": "sample string 6",
  "TerminalSerialNumber": "sample string 7",
  "securityToken": "sample string 8"
}

application/xml, text/xml

Sample:

<LoginController.clsLoginConsultaInputData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022.Controllers">
  <AppVersionNumber xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 6</AppVersionNumber>
  <CallingIPAddress xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 5</CallingIPAddress>
  <Latitud xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 3</Latitud>
  <Longitud xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 4</Longitud>
  <TerminalSerialNumber xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 7</TerminalSerialNumber>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 2</UserName>
  <securityToken xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 8</securityToken>
  <Password>sample string 1</Password>
</LoginController.clsLoginConsultaInputData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

clsLoginOutput

Name	Type	Additional information
Comercio	clsComercio	None.
Servicio	clsServicio	None.
Menu	Collection of clsMenu	None.
InstFin	Collection of clsInstFin	None.
SPEICoDiRPTResumen	PayCIPSPayCIPSResponseDataResumen	None.
SPEICoDiRPTData	Collection of PayCIPSResponseDataDetail	None.
Status	boolean	None.
RespCode	string	None.
RespText	string	None.
RespTimestamp	string	None.

Response Formats

application/json

Sample:

{
  "Comercio": {
    "Id": 1,
    "Tipo": "sample string 2",
    "Nombre": "sample string 3",
    "CLABE": "sample string 4",
    "CIE": "sample string 5",
    "Tarjeta": [
      {
        "PAN": "sample string 1",
        "FecExp": "sample string 2",
        "Tipo": "sample string 3",
        "Status": "sample string 4"
      },
      {
        "PAN": "sample string 1",
        "FecExp": "sample string 2",
        "Tipo": "sample string 3",
        "Status": "sample string 4"
      }
    ]
  },
  "Servicio": {
    "Adquirente": {
      "TPV": true,
      "Tokenizacion": true,
      "Formulario": true
    },
    "SPEI": {
      "Enviar": true,
      "Recibir": true
    },
    "CoDi": {
      "CobroPresencial": true,
      "CobroRemoto": true
    },
    "PagoCash": {
      "Oxxo24": true,
      "PayNet": true,
      "CIE": true
    }
  },
  "Menu": [
    {
      "Id": 1,
      "ParentId": 2,
      "Etiqueta": "sample string 3",
      "Titulo": "sample string 4",
      "Image": "sample string 5",
      "Order": 6,
      "OnClick": "sample string 7",
      "Param": "sample string 8",
      "ColorBG": "sample string 9",
      "ColorFG": "sample string 10",
      "ClassMenu": "sample string 11"
    },
    {
      "Id": 1,
      "ParentId": 2,
      "Etiqueta": "sample string 3",
      "Titulo": "sample string 4",
      "Image": "sample string 5",
      "Order": 6,
      "OnClick": "sample string 7",
      "Param": "sample string 8",
      "ColorBG": "sample string 9",
      "ColorFG": "sample string 10",
      "ClassMenu": "sample string 11"
    }
  ],
  "InstFin": [
    {
      "IdInstFin": 1,
      "NumRefStp": "sample string 2",
      "DescInstFin": "sample string 3",
      "AbrevInstFin": "sample string 4"
    },
    {
      "IdInstFin": 1,
      "NumRefStp": "sample string 2",
      "DescInstFin": "sample string 3",
      "AbrevInstFin": "sample string 4"
    }
  ],
  "SPEICoDiRPTResumen": null,
  "SPEICoDiRPTData": [
    null,
    {
      "mFolio": "sample string 1",
      "mTipo": "sample string 2",
      "mFecTx": "00:00:00",
      "mStatus": null,
      "mImporte": "$0.00",
      "mComision": "$0.00",
      "mCuenta": null,
      "mClaveRastreo": null,
      "mNombre": null,
      "mConcepto": null,
      "mBanco": null,
      "mRFC": null,
      "mResultado": null
    }
  ],
  "Status": true,
  "RespCode": "sample string 2",
  "RespText": "sample string 3",
  "RespTimestamp": "2026-05-03 16:51:38.276"
}

text/json

Sample:

{
  "Comercio": {
    "Id": 1,
    "Tipo": "sample string 2",
    "Nombre": "sample string 3",
    "CLABE": "sample string 4",
    "CIE": "sample string 5",
    "Tarjeta": [
      {
        "PAN": "sample string 1",
        "FecExp": "sample string 2",
        "Tipo": "sample string 3",
        "Status": "sample string 4"
      },
      {
        "PAN": "sample string 1",
        "FecExp": "sample string 2",
        "Tipo": "sample string 3",
        "Status": "sample string 4"
      }
    ]
  },
  "Servicio": {
    "Adquirente": {
      "TPV": true,
      "Tokenizacion": true,
      "Formulario": true
    },
    "SPEI": {
      "Enviar": true,
      "Recibir": true
    },
    "CoDi": {
      "CobroPresencial": true,
      "CobroRemoto": true
    },
    "PagoCash": {
      "Oxxo24": true,
      "PayNet": true,
      "CIE": true
    }
  },
  "Menu": [
    {
      "Id": 1,
      "ParentId": 2,
      "Etiqueta": "sample string 3",
      "Titulo": "sample string 4",
      "Image": "sample string 5",
      "Order": 6,
      "OnClick": "sample string 7",
      "Param": "sample string 8",
      "ColorBG": "sample string 9",
      "ColorFG": "sample string 10",
      "ClassMenu": "sample string 11"
    },
    {
      "Id": 1,
      "ParentId": 2,
      "Etiqueta": "sample string 3",
      "Titulo": "sample string 4",
      "Image": "sample string 5",
      "Order": 6,
      "OnClick": "sample string 7",
      "Param": "sample string 8",
      "ColorBG": "sample string 9",
      "ColorFG": "sample string 10",
      "ClassMenu": "sample string 11"
    }
  ],
  "InstFin": [
    {
      "IdInstFin": 1,
      "NumRefStp": "sample string 2",
      "DescInstFin": "sample string 3",
      "AbrevInstFin": "sample string 4"
    },
    {
      "IdInstFin": 1,
      "NumRefStp": "sample string 2",
      "DescInstFin": "sample string 3",
      "AbrevInstFin": "sample string 4"
    }
  ],
  "SPEICoDiRPTResumen": null,
  "SPEICoDiRPTData": [
    null,
    {
      "mFolio": "sample string 1",
      "mTipo": "sample string 2",
      "mFecTx": "00:00:00",
      "mStatus": null,
      "mImporte": "$0.00",
      "mComision": "$0.00",
      "mCuenta": null,
      "mClaveRastreo": null,
      "mNombre": null,
      "mConcepto": null,
      "mBanco": null,
      "mRFC": null,
      "mResultado": null
    }
  ],
  "Status": true,
  "RespCode": "sample string 2",
  "RespText": "sample string 3",
  "RespTimestamp": "2026-05-03 16:51:38.292"
}

application/xml, text/xml

Sample:

<LoginController.clsLoginOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022.Controllers">
  <RespCode xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 2</RespCode>
  <RespText xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">sample string 3</RespText>
  <Status xmlns="http://schemas.datacontract.org/2004/07/PayCIPSCteREST2022">true</Status>
  <Comercio>
    <CIE>sample string 5</CIE>
    <CLABE>sample string 4</CLABE>
    <Id>1</Id>
    <Nombre>sample string 3</Nombre>
    <Tarjeta>
      <LoginController.clsTarjeta>
        <FecExp>sample string 2</FecExp>
        <PAN>sample string 1</PAN>
        <Status>sample string 4</Status>
        <Tipo>sample string 3</Tipo>
      </LoginController.clsTarjeta>
      <LoginController.clsTarjeta>
        <FecExp>sample string 2</FecExp>
        <PAN>sample string 1</PAN>
        <Status>sample string 4</Status>
        <Tipo>sample string 3</Tipo>
      </LoginController.clsTarjeta>
    </Tarjeta>
    <Tipo>sample string 2</Tipo>
  </Comercio>
  <InstFin>
    <LoginController.clsInstFin>
      <AbrevInstFin>sample string 4</AbrevInstFin>
      <DescInstFin>sample string 3</DescInstFin>
      <IdInstFin>1</IdInstFin>
      <NumRefStp>sample string 2</NumRefStp>
    </LoginController.clsInstFin>
    <LoginController.clsInstFin>
      <AbrevInstFin>sample string 4</AbrevInstFin>
      <DescInstFin>sample string 3</DescInstFin>
      <IdInstFin>1</IdInstFin>
      <NumRefStp>sample string 2</NumRefStp>
    </LoginController.clsInstFin>
  </InstFin>
  <Menu>
    <LoginController.clsMenu>
      <ClassMenu>sample string 11</ClassMenu>
      <ColorBG>sample string 9</ColorBG>
      <ColorFG>sample string 10</ColorFG>
      <Etiqueta>sample string 3</Etiqueta>
      <Id>1</Id>
      <Image>sample string 5</Image>
      <OnClick>sample string 7</OnClick>
      <Order>6</Order>
      <Param>sample string 8</Param>
      <ParentId>2</ParentId>
      <Titulo>sample string 4</Titulo>
    </LoginController.clsMenu>
    <LoginController.clsMenu>
      <ClassMenu>sample string 11</ClassMenu>
      <ColorBG>sample string 9</ColorBG>
      <ColorFG>sample string 10</ColorFG>
      <Etiqueta>sample string 3</Etiqueta>
      <Id>1</Id>
      <Image>sample string 5</Image>
      <OnClick>sample string 7</OnClick>
      <Order>6</Order>
      <Param>sample string 8</Param>
      <ParentId>2</ParentId>
      <Titulo>sample string 4</Titulo>
    </LoginController.clsMenu>
  </Menu>
  <SPEICoDiRPTData>
    <LoginController.PayCIPSResponseDataDetail i:nil="true" />
    <LoginController.PayCIPSResponseDataDetail>
      <mBanco i:nil="true" />
      <mClaveRastreo i:nil="true" />
      <mComision xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">$0.00</mComision>
      <mConcepto i:nil="true" />
      <mCuenta i:nil="true" />
      <mFecTx xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">00:00:00</mFecTx>
      <mFolio>sample string 1</mFolio>
      <mImporte xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">$0.00</mImporte>
      <mNombre i:nil="true" />
      <mRFC i:nil="true" />
      <mResultado i:nil="true" />
      <mStatus i:nil="true" />
      <mTipo>sample string 2</mTipo>
    </LoginController.PayCIPSResponseDataDetail>
  </SPEICoDiRPTData>
  <SPEICoDiRPTResumen i:nil="true" />
  <Servicio>
    <Adquirente>
      <Formulario>true</Formulario>
      <TPV>true</TPV>
      <Tokenizacion>true</Tokenizacion>
    </Adquirente>
    <CoDi>
      <CobroPresencial>true</CobroPresencial>
      <CobroRemoto>true</CobroRemoto>
    </CoDi>
    <PagoCash>
      <CIE>true</CIE>
      <Oxxo24>true</Oxxo24>
      <PayNet>true</PayNet>
    </PagoCash>
    <SPEI>
      <Enviar>true</Enviar>
      <Recibir>true</Recibir>
    </SPEI>
  </Servicio>
</LoginController.clsLoginOutput>