El formato general de solicitud es: Bloco de código |
---|
| {
"companyId": "myCompanyId",
"params":[
{"param1":"param1value", "paramN":"paramNvalue", ...}
],
"items": [
{.... primer item .......},
{.... otro item .......},
{.... otro item .......},
{.... otro item .......},
{.... otro item .......},
]
} |
donde Campo | Descripción | Tipo de Dato |
---|
companyId | | alfanumérico. Requerido | params | Parámetros extra | Requerido detailedErrors: indica si se desea el detalle de errores en la respuesta. Default: true detailedSuccess: indica si se desea el detalle de registros correctos en la respuesta. Default: true validateCard: Realiza todas las validaciones del elemento de fidelidad. Por ej: el uso de cvv. Default: false. oneActiveCardByCustomer: Valida si un cliente posee un elemento de fidelidad activo. Default: true | items | Registros a importar | Colección de elementos y su operación asociada. Requerido |
El formato de los ítems es el siguiente: Campo | Descripción |
---|
operation | Operación a realizar sobre el registro. Ver tabla siguiente Requerido | code | código de elemento. En este caso si se solicita crear un elemento, el mismo será creado con este código. Si se deja por defecto genera un número automáticamente. Valor por defecto: '' | type | Tipo de Elemento en cuestión. Obligatorio, debe existir previamente. | validFrom | Valida desde. Opcional, si se deja vacío se generara acorde al tipo de elemento. El formato es "YYYY-MM-DD" | validTo | Valida Hasta. Opcional, ídem anterior. El formato es "YYYY-MM-DD" | amount | Monto asociado a la operación. Requerido | customerId | Código de cliente asociado. Valor por defecto: ''". Opcional | cvv | CVV asociado. Valor por defecto: ''". Opcional | reason | Motivo de la operación. Generalmente se utiliza en los cambios de saldo. Opcional. | stroreCode | Tienda donde se realizó la transacción. Opcional. | terminalCode | Terminal donde se realizó la transacción. Opcional. |
Aviso |
---|
| Se puede agregar a la mensajeria el storeCode y el terminalCode Bloco de código |
---|
| {
"companyId": "2",
"params": [],
"items": [
{ "operation": "ACTIVATION", "code": "6000000010", "type": "15", "validFrom":"2023-08-11", "validTo":"2023-08-11", "amount":"100", "customerId":"12", "cvv":"", "reason":"", storeCode:"3", terminalCode:"1" }
]
} |
Los cuales se detallarán en la consola en: Gestión de Elementos de Fidelidad, en el botón "acciones" /"ver" |
Los valores posibles del campo operation son: Valor | Descripción |
---|
ACTIVATION | Activación del elemento con código "code". Si se utiliza la operación "ACTIVATION" sobre un Elemento de Fidelidad que no existe, Promo lo creará además de activarlo. | AMOUNT_UPDATE | Actualización de saldo. Sumará o restará el valor según lo enviado en el Json de la operación. | RECHARGE | Recarga | CHARGE | Carga Inicial. Esta operación se utiliza exclusivamente cuando se activa una tarjeta con saldo, porque realiza la carga inicial activándola y cargándole el saldo. Nota: si activa la tarjeta sin saldo inicial, al realizar la primer carga esa operación es recharge. | CONSUME | Consumo | CANCEL | Desactivar el elemento en cuestión |
Informações |
---|
| Este servicio no permite crear mas de una tarjeta activa para un mismo cliente (sin importar si está o no asociada a un convenio). Esto se controla con la variable: "oneActiveCardByCustomer", que por default es TRUE. Elementos de Fidelidad Nominados Ejemplo 1: Se solicita la activación de un elemento de fidelidad nominado con el parámetro oneActiveCardByCustomer en true y con el cliente, que ya tiene un elemento de fidelidad activo Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Request |
---|
| {
"companyId": "napse",
"params": [
{}
],
"items": [
{
"operation": "ACTIVATION",
"code": "12110",
"type": "13",
"validFrom": "",
"validTo": "",
"amount": "0",
"customerId": "9",
"cvv": "",
"reason": "",
"storeCode": "",
"terminalCode": ""
}
]
} |
Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Response |
---|
| {
"status": "400",
"description": "rest::cardAdmin",
"detail": {
"result": "error",
"detail": "El cliente 9 ya posee un elemento de fidelidad activo"
}
} |
Ejemplo 2: Se solicita la activación de un elemento de fidelidad nominado con el parámetro oneActiveCardByCustomer en false y con el cliente: Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Request |
---|
| {
"companyId": "napse",
"params": [
{"oneActiveCardByCustomer": "false" }
],
"items": [
{
"operation": "ACTIVATION",
"code": "12100",
"type": "13",
"validFrom": "",
"validTo": "",
"amount": "0",
"customerId": "9",
"cvv": "",
"reason": "",
"storeCode": "",
"terminalCode": ""
}
]
} |
Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Response |
---|
| {
"status": 200,
"description": "rest::cardAdmin",
"transactionId": "SVC_CRD_20231023171240",
"detail": {
"result": "ok",
"detail": "",
"updated": 0,
"ignored": 0,
"inserted": 1,
"removed": 0,
"errors": 0,
"processed": 1,
"errorDetails": [],
"successDetails": [
{
"rec": 1,
"code": "12100",
"amount": "0.0"
}
]
}
} |
Se observa que se crea la tarjeta; aunque el cliente ya tiene asociada una tarjeta activa. Ejemplo 3: Se solicita la activación de un elemento de fidelidad nominado con el parámetro oneActiveCardByCustomer en true y con un cliente. Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Request |
---|
| {
"companyId": "napse",
"params": [
{}
],
"items": [
{
"operation": "ACTIVATION",
"code": "12200",
"type": "13",
"validFrom": "",
"validTo": "",
"amount": "0",
"customerId": "10",
"cvv": "",
"reason": "",
"storeCode": "",
"terminalCode": ""
}
]
} |
Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Response |
---|
| {
"status": 200,
"description": "rest::cardAdmin",
"transactionId": "SVC_CRD_20231023171241",
"detail": {
"result": "ok",
"detail": "",
"updated": 0,
"ignored": 0,
"inserted": 1,
"removed": 0,
"errors": 0,
"processed": 1,
"errorDetails": [],
"successDetails": [
{
"rec": 1,
"code": "12200",
"amount": "0.0"
}
]
}
} |
Se observa que se creó la tarjeta. Elemento de Fidelidad no Nominado Ejemplo 1: Se solicita la activación de un elemento de fidelidad no nominado sin enviar el cliente: Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Request |
---|
| {
"companyId": "2",
"params": [{}],
"items": [
{
"operation": "ACTIVATION",
"code": "10001",
"type": "12",
"validFrom": "",
"validTo": "",
"amount": "",
"customerId": "",
"cvv": "",
"reason": ""
}
]
} |
Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Response |
---|
| {
"status": "400",
"description": "rest::cardAdmin",
"detail": {
"result": "error",
"detail": "El cliente es requerido para el registro : 1"
}
} |
Ejemplo 2: Se solicita la activación de un elemento de fidelidad no nominado con el cliente: Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Request |
---|
| {
"companyId": "napse",
"params": [
{"oneActiveCardByCustomer":"false"}
],
"items": [
{
"operation": "ACTIVATION",
"code": "10002",
"type": "12",
"validFrom": "",
"validTo": "",
"amount": "0",
"customerId": "clientec",
"cvv": "",
"reason": "",
"storeCode": "",
"terminalCode": ""
}
]
} |
Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Response |
---|
| {
"status": 200,
"description": "rest::cardAdmin",
"transactionId": "SVC_CRD_20231023162247",
"detail": {
"result": "ok",
"detail": "",
"updated": 0,
"ignored": 0,
"inserted": 1,
"removed": 0,
"errors": 0,
"processed": 1,
"errorDetails": [],
"successDetails": [
{
"rec": 1,
"code": "10002",
"amount": "0.0"
}
]
}
} |
Se observa que se ha creado la tarjeta. Ejemplo 3: Se solicita la activación de un elemento de fidelidad no nominado con el parámetro oneActiveCardByCustomer en true y sin el cliente: Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Request |
---|
| {
"companyId": "napse",
"params": [
{"oneActiveCardByCustomer":"true"}
],
"items": [
{
"operation": "ACTIVATION",
"code": "10008",
"type": "12",
"validFrom": "",
"validTo": "",
"amount": "0",
"customerId": "",
"cvv": "",
"reason": "",
"storeCode": "",
"terminalCode": ""
}
]
} |
Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Response |
---|
| {
"status": "400",
"description": "rest::cardAdmin",
"detail": {
"result": "error",
"detail": "El cliente es requerido para el registro : 1"
}
} |
Ejemplo 4: Se solicita la activación de un elemento de fidelidad no nominado con el parámetro oneActiveCardByCustomer en false y sin el cliente: Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Request |
---|
| {
"companyId": "napse",
"params": [
{"oneActiveCardByCustomer":"false"}
],
"items": [
{
"operation": "ACTIVATION",
"code": "10012",
"type": "12",
"validFrom": "",
"validTo": "",
"amount": "0",
"customerId": "",
"cvv": "",
"reason": "",
"storeCode": "",
"terminalCode": ""
}
]
}
|
Bloco de código |
---|
language | xml |
---|
theme | Emacs |
---|
title | Response |
---|
| {
"status": 200,
"description": "rest::cardAdmin",
"transactionId": "SVC_CRD_20231023164008",
"detail": {
"result": "ok",
"detail": "",
"updated": 0,
"ignored": 0,
"inserted": 1,
"removed": 0,
"errors": 0,
"processed": 1,
"errorDetails": [],
"successDetails": [
{
"rec": 1,
"code": "10012",
"amount": "0.0"
}
]
}
} |
Se observa que el elemento ha sido creado. |
|