POST api/DMS/1/1/TerminalAction
Crea, actualiza o elimina una terminal en el DMS.
Información del Request
Parametros de la URI
No posee parametros
Parametros del Body
SFE.Core.Modules.DMS.TerminalActionB1| Nombre | Descripción | Tipo | Información Adicional |
|---|---|---|---|
| operation |
(EN) Process type. Allowed: 1=CREATE, 2=UPDATE, 3=DELETE. Maxlength=1. Mandatory=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. (ES) Tipo de proceso a ejecutar. Permitido: 1=CREAR, 2=ACTUALIZAR, 3=ELIMINAR. Maxlength=1. Obligatorio=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. |
integer |
N/A |
| deviceType |
(EN) Device Type. Allowed: POS, MPOS. Maxlength=15. Mandatory=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. (ES) Tipo de dispositivo. Permitido: POS, MPOS. Maxlength=15. Obligatorio=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. |
string |
N/A |
| database |
(EN) Database. Maxlength=20. Mandatory=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. (ES) Nombre de la base de datos. Maxlength=20. Obligatorio=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. |
string |
N/A |
| id |
(EN) Id. Maxlength=15. Mandatory=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. (ES) Id o Folio. Maxlength=15. Obligatorio=1,2,3-POS,MPOS. Used=1,2,3-POS,MPOS. |
string |
N/A |
| templateId |
(EN) Template Id. Maxlength=15. Mandatory=1-POS,MPOS. Used=1-POS,MPOS. (ES) Id de plantilla. Maxlength=15. Obligatorio=1-POS,MPOS. Used=1-POS,MPOS. |
string |
N/A |
| serial |
(EN) Serial. Maxlength=50. Mandatory=1-POS,MPOS. Used=1-POS,MPOS. (ES) Numero de serie. Maxlength=50. Obligatorio=1-POS,MPOS. Used=1-POS,MPOS. |
string |
N/A |
| warehouse |
(EN) Warehouse. Maxlength=250. Used=1-POS,MPOS. (ES) Bodega. Maxlength=250. Used=1-POS,MPOS. |
string |
N/A |
| assetCode |
(EN) Asset code. Maxlength=50. Used=1-POS,MPOS. (ES) Numero de activo. Maxlength=50. Used=1-POS,MPOS. |
string |
N/A |
| model |
(EN) Model. Maxlength=250. Used=1-POS,MPOS. (ES) Modelo. Maxlength=250. Used=1-POS,MPOS. |
string |
N/A |
| commerce |
(EN) Commerce. Maxlength=150. Mandatory=1-POS,MPOS. Used=1-POS,MPOS;2-MPOS. (ES) Comercio. Maxlength=150. Obligatorio=1-POS,MPOS. Used=1-POS,MPOS;2-MPOS. |
string |
N/A |
| commerceType |
(EN) Commerce type. Maxlength=150. Mandatory=If commerce must be created. Used=1-POS,MPOS. (ES) Tipo de comercio. Maxlength=150. Obligatorio=Si el comercio debe ser creado. Used=1-POS,MPOS. |
string |
N/A |
| parentCommerce |
(EN) Parent commerce. Maxlength=150. Mandatory=If commerce must be created. Used=1-POS,MPOS;2-MPOS. (ES) Comercio padre. Maxlength=150. Obligatorio=Si el comercio debe ser creado. Used=1-POS,MPOS;2-MPOS. |
string |
N/A |
| identification |
(EN) Identification. Maxlength=150. Mandatory=If commerce must be created. Used=1-POS,MPOS. (ES) Identificacion. Maxlength=150. Obligatorio=Si el comercio debe ser creado. Used=1-POS,MPOS. |
string |
N/A |
| affiliateId |
(EN) Affiliate id. Maxlength=50. Mandatory=If commerce must be created. Used=1-POS,MPOS. (ES) Id de afiliado. Maxlength=50. Obligatorio=Si el comercio debe ser creado. Used=1-POS,MPOS. |
string |
N/A |
| mcc |
(EN) Merchant Category Code. Maxlength=300. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) MCC. Maxlength=300. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| country |
(EN) Country. Maxlength=50. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) Pais. Maxlength=50. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| region |
(EN) Region. Maxlength=50. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) Region. Maxlength=50. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| district |
(EN) District. Maxlength=100. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) Distrito. Maxlength=100. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| city |
(EN) City. Maxlength=50. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) Ciudad. Maxlength=50. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| address |
(EN) Address. Maxlength=150. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) Direccion. Maxlength=150. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| phone |
(EN) Phone. Maxlength=50. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) Telefono. Maxlength=50. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| mobile |
(EN) Mobile. Maxlength=50. Mandatory=If commerce must be created. Used=1,2-POS,MPOS. (ES) Celular. Maxlength=50. Obligatorio=Si el comercio debe ser creado. Used=1,2-POS,MPOS. |
string |
N/A |
| tmlCommerce |
(EN) Terminal table commerce name field. Maxlength=32. Mandatory=1-POS,MPOS. Used=1,2-POS,MPOS. (ES) Campo nombre del comercio de la tabla terminal. Maxlength=32. Obligatorio=1-POS,MPOS. Used=1,2-POS,MPOS. |
string |
N/A |
| tmlAddress |
(EN) Terminal table address field. Maxlength=32. Mandatory=1-POS. Used=1-POS;2-POS,MPOS. (ES) Campo direccion de la tabla terminal. Maxlength=32. Obligatorio=1-POS. Used=1-POS;2-POS,MPOS. |
string |
N/A |
| tmlRucDv | string |
N/A |
|
| tmlEvents |
(EN) Terminal table events/k-sos field. Maxlength=20. Used=2-POS. (ES) Campo eventos/k-sos de la tabla terminal. Maxlength=20. Used=2-POS. |
string |
N/A |
| tmlImage |
(EN) Terminal table image collection field. Maxlength=20. Used=2-POS. (ES) Campo coleccion de imagenes de la tabla terminal. Maxlength=20. Used=2-POS. |
string |
N/A |
| tmlSupPass |
(EN) Terminal table supervisor password field. Maxlength=6. Used=2-POS. (ES) Campo contrasena de supervisor de la tabla terminal. Maxlength=6. Used=2-POS. |
integer |
N/A |
| tmlUsrPass |
(EN) Terminal table user password field. Maxlength=6. Used=2-POS. (ES) Campo contrasena de usuario de la tabla terminal. Maxlength=6. Used=2-POS. |
integer |
N/A |
| tmlRsaKey |
(EN) Terminal table RSA key field. Maxlength=20. Used=2-POS. (ES) Campo llave RSA de la tabla terminal. Maxlength=20. Used=2-POS. |
string |
N/A |
| tmlTxnVoid |
(EN) Terminal table transactions void field. Used=2-POS. (ES) Campo anular transacciones de la tabla terminal. Used=2-POS. |
boolean |
N/A |
| tmlBatchClose |
(EN) Terminal table allow batch close field. Used=2-POS. (ES) Campo pertimir anular transaccion de la tabla terminal. Used=2-POS. |
boolean |
N/A |
| tmlRefund |
(EN) Terminal table allow refunds field. Used=2-POS. (ES) Campo pertimir devoluciones de la tabla terminal. Used=2-POS. |
boolean |
N/A |
| tmlReport |
(EN) Terminal table allow reports field. Used=2-POS. (ES) Campo pertimir reportes de la tabla terminal. Used=2-POS. |
boolean |
N/A |
| tmlTxnSet |
(EN) Terminal table allow transactions set field. Used=2-POS. (ES) Campo pertimir ajustar transacciones de la tabla terminal. Used=2-POS. |
boolean |
N/A |
| tmlDslConsole |
(EN) Terminal table allow DSL console field. Used=2-POS. (ES) Campo pertimir consola DSL de la tabla terminal. Used=2-POS. |
boolean |
N/A |
| tmlDslTcp |
(EN) Terminal table DSL TCP Socket field. Used=2-POS. (ES) Campo DSL por socket TCP de la tabla terminal. Used=2-POS. |
boolean |
N/A |
| tmlRs232CommSpeed |
(EN) Terminal table RS232 communication speed field. Maxlength=1. Used=2-POS. (ES) Campo velocidad de comunicacion RS232 de la tabla terminal. Maxlength=1. Used=2-POS. |
integer |
N/A |
| merchantList |
(EN) Merchant list with the properties that will be changed. (ES) Listado de los merchant con las propiedades que se cambiarán de cada uno. |
Collection of SFE.Core.Modules.DMS.TerminalMerchantB1 |
N/A |
| acquirerList |
(EN) Acquirer list with the properties that will be changed. (ES) Listado de los adquirentes con las propiedades que se cambiarán de cada uno. |
Collection of SFE.Core.Modules.DMS.TerminalAcquirerB1 |
N/A |
Ejemplos de request:
application/json, text/json
{
"operation": 1,
"deviceType": "sample string 2",
"database": "sample string 3",
"id": "sample string 4",
"templateId": "sample string 5",
"serial": "sample string 6",
"warehouse": "sample string 7",
"assetCode": "sample string 8",
"model": "sample string 9",
"commerce": "sample string 10",
"commerceType": "sample string 11",
"parentCommerce": "sample string 12",
"identification": "sample string 13",
"affiliateId": "sample string 14",
"mcc": "sample string 15",
"country": "sample string 16",
"region": "sample string 17",
"district": "sample string 18",
"city": "sample string 19",
"address": "sample string 20",
"phone": "sample string 21",
"mobile": "sample string 22",
"tmlCommerce": "sample string 23",
"tmlAddress": "sample string 24",
"tmlRucDv": "sample string 25",
"tmlEvents": "sample string 26",
"tmlImage": "sample string 27",
"tmlSupPass": 28,
"tmlUsrPass": 29,
"tmlRsaKey": "sample string 30",
"tmlTxnVoid": true,
"tmlBatchClose": true,
"tmlRefund": true,
"tmlReport": true,
"tmlTxnSet": true,
"tmlDslConsole": true,
"tmlDslTcp": true,
"tmlRs232CommSpeed": 38,
"merchantList": [
{
"templateMerchantId": "sample string 1",
"merchantId": "sample string 2",
"mctReqCashier": true,
"mctReqTip": true,
"mctMaxTip": 5,
"mctReqTax": true,
"mctMaxTax": 7
},
{
"templateMerchantId": "sample string 1",
"merchantId": "sample string 2",
"mctReqCashier": true,
"mctReqTip": true,
"mctMaxTip": 5,
"mctReqTax": true,
"mctMaxTax": 7
}
],
"acquirerList": [
{
"templateMerchantId": "sample string 1",
"merchantId": "sample string 2",
"acquirerId": "sample string 3",
"acqTerminalId": "sample string 4",
"acqMerchantId": "sample string 5",
"acqManualInput": true,
"acqSetAllowed": true,
"acqRefund": true,
"acqCheckInOut": true,
"acqVoid": true,
"acqMaxCloseDays": 11,
"acqCloseHour": "sample string 12",
"acqIssuer": [
"sample string 1",
"sample string 2"
]
},
{
"templateMerchantId": "sample string 1",
"merchantId": "sample string 2",
"acquirerId": "sample string 3",
"acqTerminalId": "sample string 4",
"acqMerchantId": "sample string 5",
"acqManualInput": true,
"acqSetAllowed": true,
"acqRefund": true,
"acqCheckInOut": true,
"acqVoid": true,
"acqMaxCloseDays": 11,
"acqCloseHour": "sample string 12",
"acqIssuer": [
"sample string 1",
"sample string 2"
]
}
]
}
application/xml, text/xml
<terminalActionB1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Core.Modules.DMS">
<acquirerList>
<terminalAcquirerB1>
<acqCheckInOut>true</acqCheckInOut>
<acqCloseHour>sample string 12</acqCloseHour>
<acqIssuer xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</acqIssuer>
<acqManualInput>true</acqManualInput>
<acqMaxCloseDays>11</acqMaxCloseDays>
<acqMerchantId>sample string 5</acqMerchantId>
<acqRefund>true</acqRefund>
<acqSetAllowed>true</acqSetAllowed>
<acqTerminalId>sample string 4</acqTerminalId>
<acqVoid>true</acqVoid>
<acquirerId>sample string 3</acquirerId>
<merchantId>sample string 2</merchantId>
<templateMerchantId>sample string 1</templateMerchantId>
</terminalAcquirerB1>
<terminalAcquirerB1>
<acqCheckInOut>true</acqCheckInOut>
<acqCloseHour>sample string 12</acqCloseHour>
<acqIssuer xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</acqIssuer>
<acqManualInput>true</acqManualInput>
<acqMaxCloseDays>11</acqMaxCloseDays>
<acqMerchantId>sample string 5</acqMerchantId>
<acqRefund>true</acqRefund>
<acqSetAllowed>true</acqSetAllowed>
<acqTerminalId>sample string 4</acqTerminalId>
<acqVoid>true</acqVoid>
<acquirerId>sample string 3</acquirerId>
<merchantId>sample string 2</merchantId>
<templateMerchantId>sample string 1</templateMerchantId>
</terminalAcquirerB1>
</acquirerList>
<address>sample string 20</address>
<affiliateId>sample string 14</affiliateId>
<assetCode>sample string 8</assetCode>
<city>sample string 19</city>
<commerce>sample string 10</commerce>
<commerceType>sample string 11</commerceType>
<country>sample string 16</country>
<database>sample string 3</database>
<deviceType>sample string 2</deviceType>
<district>sample string 18</district>
<id>sample string 4</id>
<identification>sample string 13</identification>
<mcc>sample string 15</mcc>
<merchantList>
<terminalMerchantB1>
<mctMaxTax>7</mctMaxTax>
<mctMaxTip>5</mctMaxTip>
<mctReqCashier>true</mctReqCashier>
<mctReqTax>true</mctReqTax>
<mctReqTip>true</mctReqTip>
<merchantId>sample string 2</merchantId>
<templateMerchantId>sample string 1</templateMerchantId>
</terminalMerchantB1>
<terminalMerchantB1>
<mctMaxTax>7</mctMaxTax>
<mctMaxTip>5</mctMaxTip>
<mctReqCashier>true</mctReqCashier>
<mctReqTax>true</mctReqTax>
<mctReqTip>true</mctReqTip>
<merchantId>sample string 2</merchantId>
<templateMerchantId>sample string 1</templateMerchantId>
</terminalMerchantB1>
</merchantList>
<mobile>sample string 22</mobile>
<model>sample string 9</model>
<operation>1</operation>
<parentCommerce>sample string 12</parentCommerce>
<phone>sample string 21</phone>
<region>sample string 17</region>
<serial>sample string 6</serial>
<templateId>sample string 5</templateId>
<tmlAddress>sample string 24</tmlAddress>
<tmlBatchClose>true</tmlBatchClose>
<tmlCommerce>sample string 23</tmlCommerce>
<tmlDslConsole>true</tmlDslConsole>
<tmlDslTcp>true</tmlDslTcp>
<tmlEvents>sample string 26</tmlEvents>
<tmlImage>sample string 27</tmlImage>
<tmlRefund>true</tmlRefund>
<tmlReport>true</tmlReport>
<tmlRs232CommSpeed>38</tmlRs232CommSpeed>
<tmlRsaKey>sample string 30</tmlRsaKey>
<tmlRucDv>sample string 25</tmlRucDv>
<tmlSupPass>28</tmlSupPass>
<tmlTxnSet>true</tmlTxnSet>
<tmlTxnVoid>true</tmlTxnVoid>
<tmlUsrPass>29</tmlUsrPass>
<warehouse>sample string 7</warehouse>
</terminalActionB1>
Información del Response
Descripción de los parametros
SFE.Core.Layer.Models.SimpleResponse| Nombre | Descripción | Tipo | Información Adicional |
|---|---|---|---|
| code | string |
N/A |
|
| message | string |
N/A |
|
| details | Collection of SFE.Core.Layer.Models.DetailResponse |
N/A |
Ejemplos de response:
application/json, text/json
{
"code": "sample string 1",
"message": "sample string 2",
"details": [
{
"field": "sample string 1",
"value": "sample string 2",
"code": "sample string 3",
"message": "sample string 4"
},
{
"field": "sample string 1",
"value": "sample string 2",
"code": "sample string 3",
"message": "sample string 4"
}
]
}
application/xml, text/xml
<simpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFE.Core.Layer.Models">
<code>sample string 1</code>
<details>
<detailResponse>
<code>sample string 3</code>
<field>sample string 1</field>
<message>sample string 4</message>
<value>sample string 2</value>
</detailResponse>
<detailResponse>
<code>sample string 3</code>
<field>sample string 1</field>
<message>sample string 4</message>
<value>sample string 2</value>
</detailResponse>
</details>
<message>sample string 2</message>
</simpleResponse>