Histórico da Página

...

Expandir

title	Importación Catalogo Elemento de Fidelidad

Para la importación de elementos de fidelidad por medio del servicio Rest, deberá considerarse el siguiente formato general:

Bloco de código

language	xml
theme	Emacs
title	input

{
    "companyId": "napse",
    "catalog": "Card",
    "params": [],
    "items": [
        {
            "code": "4567000000000",
            "type": "tipo1",
            "validFrom": "",
            "validTo": "",
            "cvv": "123",
            "customerId": "1122",
            "amount": 50,
            "status": "ENABLED",
            "operation": "I"
        },
        {
            "code": "3456000000001",
            "type": "tipo2",
            "validFrom": "",
            "validTo": "",
            "cvv": "234",
            "customerId": "2233",
            "amount": 45.5,
            "status": "DISABLED",
            "operation": "U"
        },
        {
            "code": "3456000000002",
            "type": "tipo2",
            "validFrom": "",
            "validTo": "",
            "cvv": "345",
            "customerId": "2233",
            "amount": 35.5,
            "status": "ENABLED",
            "operation": "R"
        }
    ]
}

En la sección "ítems" deberán indicarse la colección de objetos dependientes de cada catálogo, en este caso, el de elementos, "Card"

Campo

Valor

code

El código del elemento.

type

El código del tipo de elemento.

validFrom

Fecha de inicio de vigencia (considerar los tipos de vigencia existentes en el tipo de elemento relacionado). Formato año-mes-día, 4 dígitos, 2 dígitos, 2 dígitos; por ej. "2020-05-14"

validTo

Fecha de fin de vigencia (considerar los tipos de vigencia existentes en el tipo de elemento relacionado). Formato año-mes-día, 4 dígitos, 2 dígitos, 2 dígitos; por ej. "2020-05-14"

cvv

Número cvv.

customerId

El código de cliente al cual pertenece el elemento (considerar el campo nominado del tipo de elemento). Alfanumérico.

amount

El monto del elemento (considerar el tipo de precarga del tipo del elemento). Numérico con decimales.

Aviso

title	IMPORTANTE

Este valor sólo se debe agregar si el tipo de elemento de fidelidad al que pertenece el elemento es precargado por archivo/servicio

status

El estado del elemento. Los valores posibles para el status son: ENABLED (elemento activo), DISABLED (elemento inactivo), CANCELED (elemento cancelado).

operation

La operación a realizar sobre el elemento. Los valores posibles son: I: Inserción / U: Actualización / R: Eliminación

...

Expandir

title	Ejemplo

Ejemplo de Envío de registro.

En este caso se envían las siguientes tarjetas:

solicitar crear una tarjeta "1000000005", de tipo 1, con saldo de 1000.
solicitar crear una tarjeta "1010000000", de tipo 2, con saldo de 150.
solicitar crear una tarjeta "2010000001", de tipo 3, con saldo de 50.
solicitar crear una tarjeta "7010000000", de tipo 4, con saldo de 1000.
solicitar crear una tarjeta "1100000001", de tipo 5, con saldo de 1000.
solicitar crear una tarjeta "1300000001", de tipo 6, con saldo de 100.
solicitar crear una tarjeta "7000000000", de tipo 7, con saldo de 1000.
solicitar crear una tarjeta "1000000005", de tipo 8, con saldo de 1000

Bloco de código

language	yml
theme	Emacs

{
    "companyId": "2",
    "params": [{"oneActiveCardByCustomer":"false", "validatedCardvalidateCard":"true"}],
    "items": [
        { "operation": "ACTIVATION", "code": "1000000005", "type": "1", "validFrom":"", "validTo":"", "amount":"1000", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "ACTIVATION", "code": "1010000000", "type": "2", "validFrom":"", "validTo":"", "amount":"150", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "ACTIVATION", "code": "2010000001", "type": "3", "validFrom":"", "validTo":"", "amount":"50", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "ACTIVATION", "code": "7010000000", "type": "4", "validFrom":"2023-08-14", "validTo":"2024-08-14", "amount":"1000", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "ACTIVATION", "code": "1100000001", "type": "5", "validFrom":"", "validTo":"", "amount":"1000", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "ACTIVATION", "code": "1300000001", "type": "6", "validFrom":"", "validTo":"", "amount":"100", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "ACTIVATION", "code": "7000000000", "type": "7", "validFrom":"", "validTo":"", "amount":"1000", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "ACTIVATION", "code": "1000000005", "type": "8", "validFrom":"", "validTo":"", "amount":"1000", "customerId":"", "cvv":"", "reason":""  }
    ]
}

Bloco de código

language	xml
theme	Emacs
title	Response

{
    "status": 200,
    "description": "rest::cardAdmin",
    "transactionId": "SVC_CRD_20230814181744",
    "detail": {
        "result": "ok",
        "detail": "",
        "updated": 0,
        "ignored": 0,
        "inserted": 5,
        "removed": 0,
        "errors": 3,
        "processed": 8,
        "errorDetails": [
            {
                "rec": 1,
                "code": "9520",
                "info": null
            },
            {
                "rec": 5,
                "code": "9520",
                "info": null
            },
            {
                "rec": 8,
                "code": "9520",
                "info": null
            }
        ],
        "successDetails": [
            {
                "rec": 2,
                "code": "1010000000",
                "amount": "150.0"
            },
            {
                "rec": 3,
                "code": "2010000001",
                "amount": "50.0"
            },
            {
                "rec": 4,
                "code": "7010000000",
                "amount": "1000.0"
            },
            {
                "rec": 6,
                "code": "1300000001",
                "amount": "100.0"
            },
            {
                "rec": 7,
                "code": "7000000000",
                "amount": "1000.0"
            }
        ]
    }
}

la respuesta informa sobre el Id de la transaction

y el amount del elemento de fidelidad.

2. Se solicita modificar la carga de la tarjeta 1000000010 con 1000. Inicialmente no tenia carga

Bloco de código

language	xml
theme	Emacs
title	Request

{
    "companyId": "2",
    "params": [{"oneActiveCardByCustomer":"false", "validatedCardvalidateCard":"true"}],
    "items": [
        { "operation": "AMOUNT_UPDATE", "code": "1000000010", "type": "1", "validFrom":"", "validTo":"", "amount":"1000.00", "customerId":"", "cvv":"", "reason":""  }
        
    ]
}

Bloco de código

language	xml
theme	Emacs
title	Response

{
    "status": 200,
    "description": "rest::cardAdmin",
    "transactionId": "SVC_CRD_20230814182939",
    "detail": {
        "result": "ok",
        "detail": "",
        "updated": 1,
        "ignored": 0,
        "inserted": 0,
        "removed": 0,
        "errors": 0,
        "processed": 1,
        "errorDetails": [],
        "successDetails": [
            {
                "rec": 1,
                "code": "1000000010",
                "amount": "2000.0"
            }
        ]
    }
}

3 . Se solicita consumir 30 de la tarjeta "1010000000"

Bloco de código

language	xml
theme	Emacs
title	Request

{
    "companyId": "2",
    "params": [{"oneActiveCardByCustomer":"false", "validatedCardvalidateCard":"true"}],
    "items": [
        { "operation": "CONSUME", "code": "1010000000", "type": "1", "validFrom":"", "validTo":"", "amount":"30.00", "customerId":"", "cvv":"", "reason":""  }
        
    ]
}

Bloco de código

language	xml
theme	Emacs
title	Response

{
    "status": 200,
    "description": "rest::cardAdmin",
    "transactionId": "SVC_CRD_20230814183317",
    "detail": {
        "result": "ok",
        "detail": "",
        "updated": 1,
        "ignored": 0,
        "inserted": 0,
        "removed": 0,
        "errors": 0,
        "processed": 1,
        "errorDetails": [],
        "successDetails": [
            {
                "rec": 1,
                "code": "1010000000",
                "amount": "120.0"
            }
        ]
    }
}

Se observa que ahora la tarjeta tiene un saldo de 120; cuando inicialmente era de 150

4. Se solicita recargar 30 a la tarjeta "4200000002"

Bloco de código

language	xml
theme	Emacs
title	Request

{
    "companyId": "2",
    "params": [{"oneActiveCardByCustomer":"false", "validatedCardvalidateCard":"true"}],
    "items": [
        { "operation": "RECHARGE", "code": "4200000002", "type": "6", "validFrom":"", "validTo":"", "amount":"30.00", "customerId":"", "cvv":"", "reason":""  }
        
    ]
}

Bloco de código

language	xml
theme	Emacs
title	Response

{
    "status": 200,
    "description": "rest::cardAdmin",
    "transactionId": "SVC_CRD_20230814183628",
    "detail": {
        "result": "ok",
        "detail": "",
        "updated": 1,
        "ignored": 0,
        "inserted": 0,
        "removed": 0,
        "errors": 0,
        "processed": 1,
        "errorDetails": [],
        "successDetails": [
            {
                "rec": 1,
                "code": "4200000002",
                "amount": "1180.0"
            }
        ]
    }
}

5. Se solicita cargar 1000 a la tarjeta "7000000000"

Bloco de código

language	xml
theme	Emacs
title	Request

{
    "companyId": "2",
    "params": [{"oneActiveCardByCustomer":"false", "validatedCardvalidateCard":"true"}],
    "items": [
        { "operation": "CHARGE", "code": "7000000000", "type": "7", "validFrom":"", "validTo":"", "amount":"1000.00", "customerId":"", "cvv":"", "reason":""  }
        
    ]
}

Bloco de código

language	xml
theme	Emacs
title	Response

{
    "status": 200,
    "description": "rest::cardAdmin",
    "transactionId": "SVC_CRD_20230814184411",
    "detail": {
        "result": "ok",
        "detail": "",
        "updated": 1,
        "ignored": 0,
        "inserted": 0,
        "removed": 0,
        "errors": 0,
        "processed": 1,
        "errorDetails": [],
        "successDetails": [
            {
                "rec": 1,
                "code": "7000000000",
                "amount": "2000.0"
            }
        ]
    }
}

6. Se solicita cancelar la tarjeta "7000000000"

Bloco de código

language	xml
theme	Emacs
title	Request

{
    "companyId": "2",
    "params": [{"oneActiveCardByCustomer":"false", "validatedCardvalidateCard":"true"}],
    "items": [
        { "operation": "CANCEL", "code": "7000000000", "type": "7", "validFrom":"", "validTo":"", "amount":"1000.00", "customerId":"", "cvv":"", "reason":""  }
        
    ]
}

Bloco de código

language	xml
theme	Emacs
title	Response

{
    "status": 200,
    "description": "rest::cardAdmin",
    "transactionId": "SVC_CRD_20230814184627",
    "detail": {
        "result": "ok",
        "detail": "",
        "updated": 1,
        "ignored": 0,
        "inserted": 0,
        "removed": 0,
        "errors": 0,
        "processed": 1,
        "errorDetails": [],
        "successDetails": [
            {
                "rec": 1,
                "code": "7000000000",
                "amount": "2000.0"
            }
        ]
    }
}

donde

Campo	Descripción	Tipo de Dato
status	código de respuesta	200 indica que ha sido procesada correctamente.
description	Descripción general	Fijo "rest::cardAdmin'
transactionId	Id de la transaccion	string
detail	Detalle del proceso	array
detail.result	Resultado general del proceso	ok indicando proceso realizado
detail.detail	Mensaje detallado respecto al proceso	vacío en el caso de ok
detail.updated	cantidad de ítems actualizados	integer
detail.ignored	cantidad de ítems ignorados	integer
detail.inserted	cantidad de ítems agregados	integer
detail.removed	cantidad de ítems removidos	integer
detail.errors	cantidad de ítems erróneos	integer
detail.processed	cantidad de ítems procesados	integer
detail.errorDetails	Detalle de cada registro con error.	rec: numero de registro en la solicitud code: código de error. Ver lista de errores en el Manual de Integración - Motor 7.2, info: mensaje informativo del error, puede devolver NULL.
detail.successDetails	Detalle de cada registro procesado correctamente	rec: Numero de registro en la solicitud code: código del elemento. amount: carga del elemento de fidelidad

Los resultados de estas operaciones se verán reflejados en la Consola/Módulo de Fidelidad/Elementos de Fidelidad.

...

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave