Histórico da Página

...

Expandir

title	Solicitud

El formato general de solicitud es:

Bloco de código

language	yml
theme	Emacs

{
 "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	codigo de Empresa	alfanumérico
params	Parametros extra	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
items	Registros a importar	Coleccion de tarjetas y su operacion asociada.

El formato de los items es el siguiente:

Campo	Descripción
operation	Operacion a realizar sobre el registro. Ver tabla siguiente
code	codigo de tarjeta. En este caso si se solicita crear una tarjeta, la misma será creada con este codigo. Si se deja por defecto genera un número automaticamente. Valor por defecto: ''
type	Tipo de Tarjeta en cuestión. Obligatorio, debe existir previamente.
validFrom	Valida desde. Opcional, si se deja vacio se generara acorde al tipo de tarjeta.
validTo	Valida Hasta. Opcional, idem anterior.
amount	Monto asociado a la operación.
customerId	Cliente asociado. Valor por defecto: ''
cvv	CVV asociado. Valor por defecto: ''
reason	Motivo de la operación. Generalmente se utiliza en los cambios de saldo.

Los valores posibles del campo operation son:

Valor	Descripción
ACTIVATION	Activación de la tarjeta con codigo "code".
AMOUNT_UPDATE	Actualización de saldo
RECHARGE	Recarga
CHARGE	Carga Inicial
CONSUME	Consumo
CANCEL	Desactivar la tarjeta en cuestión

Expandir

title	Ejemplo

Ejemplo de Envio de registro. En este caso se envian las siguientes tarjetas:

Se solicitar crear una tarjeta "999.999' con saldo de 100.
Se solicita cargar la tarjeta 999.998 con 50
Se solicita consumir 30 de la tarjeta 999.997
Se cancela la tarjeta 999.996

Bloco de código

language	yml
theme	Emacs

{
    "companyId": "napse",
    "params": [],
    "items": [
        { "operation": "CREATEACTIVATION", "code": "999999", "type": "mytype", "validFrom":"-", "validTo":"-", "amount":"100", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "RECHARGE", "code": "999998", "type": "mytype", "validFrom":"-", "validTo":"-", "amount":"50", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "CONSUME", "code": "999997", "type": "mytype", "validFrom":"-", "validTo":"-", "amount":"30", "customerId":"", "cvv":"", "reason":""  },
        { "operation": "CANCEL", "code": "999996", "type": "mytype", "validFrom":"-", "validTo":"-", "amount":"0", "customerId":"", "cvv":"", "reason":""  },
    ]
}

...

Expandir

title	Solicitud

El formato general de solicitud es:

Bloco de código

language	yml
theme	Emacs

{
 "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	codigo de Empresa	alfanumérico
params	Parametros extra	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
items	Registros a importar	Coleccion de cupones y su operacion asociada.

El formato de los items es el siguiente:

Campo	Descripción
operation	Operacion a realizar sobre el registro. Ver tabla siguiente
barcode	Código de barras del cupón. En este caso si se solicita crear una tarjeta, la misma será creada con este codigo. Si se deja por defecto genera un número automaticamente. Valor por defecto: ''
email	Correo electronico destino para cupones de tipo electronico. Opcional. Valor por defecto: ""
type	Tipo de Cupón. Obligatorio, debe existir previamente.
amount	Monto asociado a la operación.
customerId	Cliente asociado. Valor por defecto: ''

Los valores posibles del campo operation son:

Valor	Descripción
CREATE	Emitir/Crear el cupón informado.
REDEEM	Redención
VOID	Desactivar

Expandir

title	Ejemplo

Ejemplo de Envio de registro. En este caso se envian los siguientes cupones:

Se solicitar crear el cupon ABC345 con valor de 100.
Se solicita redimir el cupon ABC344.
Se solicita anular el cupon ABC343

Bloco de código

language	yml
theme	Emacs

{
    "companyId": "napse",
    "params": [],
    "items": [
        { "operation": "CREATE", "barcode": "ABC345", "type": "mytype", "email":"[email protected]", "amount":"100", "customerId":"mycustomer" },
        { "operation": "REDEEM", "barcode": "ABC344", "type": "mytype", "email":"", "amount":"0", "customerId":""  },
        { "operation": "VOID", "barcode": "ABC343", "type": "mytype", "email":"", "amount":"0", "customerId":"" }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 17

Nova versão 18

Chave