Vinculación Backend

Apis para vincular en backend

POST /reader/activate

Api para vincular un terminal “Standalone” en el backend

Request body

Object

fullSerialNumber

string

Serie inscrita en el backend en el campo “terminalSerieFisica”

Example:

61738368

activationCode

string

Codigo de activación generado

Example:

562192

Examples

{
    "fullSerialNumber": "61738368",
    "activationCode": "562192"
}

Responses

200 OK

Respuesta correcta de vinculación

Body

Object

data

Object

Estructura de respuesta

X-Authentication-ApiKey

string required

Api key, usado para desvincular (no expira)

Example:

1QvJSR6LsEoAP915Uk8lHa3lqp8fYlN9r2gD7ELvZBTtuSrw94adsIqst3jGPdsad4321412

X-Authentication-Token

string required

Api token, usado para desvincular (no expira)

Example:

dt_702da7fdd01cc55e15c55441671f7a6ce6112cb3ac7

subMerchantId

string required

Código único VISANET (código del comercio)

Example:

845030792

subMerchantName

string required

Nombre del comercio

Example:

JCA EIRLL

classificationCode

string required

Código MCC

Example:

5045

classificationName

string required

Rubro del comercio

Example:

Computacion HW y SW

Examples

Ejemplo de vinculación completa

{
    "data": {
        "X-Authentication-ApiKey": "1QvJSR6LsEoAP915Uk8lHa3lqp8fYlN9r2gD7ELvZBTtuSrw94adsIqst3jGPdsad4321412",
        "X-Authentication-Token": "dt_702da7fdd01cc55e15c55441671f7a6ce6112cb3ac7",
        "subMerchantId": "845030792",
        "subMerchantName": "JCA EIRLL",
        "classificationCode": "5045",
        "classificationName": "Computacion HW y SW"
    }
}

400 Error de aplicación

Error por validación interna en la aplicación

Body

Object

error

string required

Código técnico del error

Enumeration:

errors.activation_code_invalid

Codigo de activacion invalido

errors.invalid_reader

El lector es invalido

errors.terminal_not_available

Terminal no disponible

errors.invalid_resource_id

Error interno en aplicación

response

Object required

code

integer required

Código numérico de la respuesta

Example:

400

message

string required

Descripción del mensaje

Examples:

Codigo de activacion invalidoEl lector es invalidoTerminal no disponible

Examples

Ejemplo donde el lector no es válido

{
    "error": "errors.activation_code_invalid",
    "response": {
        "code": 400,
        "message": "El lector es invalido"
    }
}

500 Internal Server Error

Error interno en el servidor

Body

Object

error

string required

Código técnico del error

Example:

Unknown error

response

Object required

code

integer required

Código numérico de la respuesta

Example:

500

message

string required

Descripción del mensaje

Example:

Something wrong

Examples

{
    "error": "Unknown error",
    "response": {
        "code": 500,
        "message": "Something wrong"
    }
}

POST /reader/deactivate

Api para desvincular un terminal “Standalone” en el backend

Request headers

X-Authentication-ApiKey

string required

Api-Key devuelta en la vinculación

Example:

1QvJSR6LsEoAP915Uk8lHa3lqp8fYlN9r2gD7ELvZBTtuSrw94adsIqst3jGPdsad4321412

X-Authentication-Token

string required

Api-Token devuelto en la vinculación

Example:

dt_702da7fdd01cc55e15c55441671f7a6ce6112cb3ac7

string required

Header genérico para JSON

Example:

application/json

Content-Type

string required

Header genérico para JSON

Example:

application/json

Request body

Object

fullSerialNumber

string

Serie inscrita en el backend en el campo “terminalSerieFisica”

Example:

6K848396

Examples

{
    "fullSerialNumber": "6K848396"
}

Responses

200 OK

Respuesta correcta de desvinculación (no tiene body)

400 Error de aplicación

Error por validación interna en la aplicación

Body

Object

error

string required

Código técnico del error

Enumeration:

errors.invalid_reader

El lector es inválido

errors.terminal_not_found

Terminal no encontrado

response

Object required

code

integer required

Código numérico de la respuesta

Example:

400

message

string required

Descripción del mensaje

Examples:

El lector es inválidoTerminal no encontrado

Examples

Lector Inválido

{
    "error": "errors.terminal_not_found",
    "response": {
        "code": 400,
        "message": "El lector es inválido"
    }
}

401 Unauthorized

No autorizado

Body

Object

error

string required

Código técnico del error

Enumeration:

errors.unauthorized

El token de sesión no es válido o ha expirado

response

Object required

code

integer required

Código numérico de la respuesta

Example:

401

message

string required

Descripción del mensaje

Example:

El token de sesión no es válido o ha expirado

Examples

No autorizado

{
    "error": "errors.unauthorized",
    "response": {
        "code": 401,
        "message": "El token de sesión no es válido o ha expirado"
    }
}

402 Payment Required

Error de usuario

Body

Object

error

string required

Código técnico del error

Enumeration:

errors.wrong_user

El usuario no se encuentra habilitado

response

Object required

code

integer required

Código numérico de la respuesta

Example:

402

message

string required

Descripción del mensaje

Example:

El usuario no se encuentra habilitado

Examples

Error de usuario

{
    "error": "errors.wrong_user",
    "response": {
        "code": 402,
        "message": "El usuario no se encuentra habilitado"
    }
}

500 Internal Server Error

Error interno en el servidor

Body

Object

error

string required

Código técnico del error

Example:

Something wrong

response

Object required

code

integer required

Código numérico de la respuesta

Example:

500

message

string required

Descripción del mensaje

Example:

Something wrong

Examples

Error de servidor

{
    "error": "Something wrong",
    "response": {
        "code": 500,
        "message": "Something wrong"
    }
}

POST /reader/deactivate

Api para desvincular un terminal “Standalone” en el backend, a diferencia del api clásica, esta no requiere Api-Key y Api-Token

Request headers

string required

Header genérico para JSON

Example:

application/json

Content-Type

string required

Header genérico para JSON

Example:

application/json

Request body

Object

fullSerialNumber

string

Serie inscrita en el backend en el campo “terminalSerieFisica”

Example:

6K848396

Examples

{
    "fullSerialNumber": "6K848396"
}

Responses

200 OK

Respuesta correcta de desvinculación (no tiene body)

400 Error de aplicación

Error por validación interna en la aplicación

Body

Object

error

string required

Código técnico del error

Enumeration:

errors.invalid_reader

El lector es inválido

errors.terminal_not_found

Terminal no encontrado

response

Object required

code

integer required

Código numérico de la respuesta

Example:

400

message

string required

Descripción del mensaje

Examples:

El lector es inválidoTerminal no encontrado

Examples

Lector Inválido

{
    "error": "errors.terminal_not_found",
    "response": {
        "code": 400,
        "message": "El lector es inválido"
    }
}

401 Unauthorized

No autorizado

Body

Object

error

string required

Código técnico del error

Enumeration:

errors.unauthorized

El token de sesión no es válido o ha expirado

response

Object required

code

integer required

Código numérico de la respuesta

Example:

401

message

string required

Descripción del mensaje

Example:

El token de sesión no es válido o ha expirado

Examples

No autorizado

{
    "error": "errors.unauthorized",
    "response": {
        "code": 401,
        "message": "El token de sesión no es válido o ha expirado"
    }
}

402 Payment Required

Error de usuario

Body

Object

error

string required

Código técnico del error

Enumeration:

errors.wrong_user

El usuario no se encuentra habilitado

response

Object required

code

integer required

Código numérico de la respuesta

Example:

402

message

string required

Descripción del mensaje

Example:

El usuario no se encuentra habilitado

Examples

Error de usuario

{
    "error": "errors.wrong_user",
    "response": {
        "code": 402,
        "message": "El usuario no se encuentra habilitado"
    }
}

500 Internal Server Error

Error interno en el servidor

Body

Object

error

string required

Código técnico del error

Example:

Something wrong

response

Object required

code

integer required

Código numérico de la respuesta

Example:

500

message

string required

Descripción del mensaje

Example:

Something wrong

Examples

Error de servidor

{
    "error": "Something wrong",
    "response": {
        "code": 500,
        "message": "Something wrong"
    }
}