Prestamos HA
by integracionesvendemas

Prestamos HA

API REST Préstamos

El proyecto préstamos es una colección de API REST que disponibiliza operaciones de los negocios de evaluación de créditos, préstamos y recaudos a los comercios de la red Vendemás. Es necesario autenticarse para obtener un token de acceso a las operaciones del API, este token debe viajar en el header de cada operación.

URLs base ambiente Sandbox por solución:

Autenticación:

https://auth2.qa.vmas.com.pe/vm-api-autorizacion/oauth/token

Generación de token para el uso de los servicios del api prestamos

  • Generar Token

Prestamos Base URL:

https://loans.qa.vmas.com.pe/

  • Obtener Comercio
  • Aceptación TyC
  • Obtener Estado Comercio
  • Obtener Reporte
  • Obtener Disponible
  • Crear Contrato
  • Estado Transacción
  • Estado Diario
  • Obtener Contrato
  • Autorización
  • Reversa
  • Cancelar Contrato
  • Modificar Contrato

APIS Prestamistas:

Para la integración de las entidades financieras a la plataforma de prestamos, se tienen que realizar dos APIS:

  • Endpoint Fintech (dominio-fintech/token)
  • Notificar Interes Comercio (/dominio-fintech/notify/merchant)
APIS Prestamos
Generar Token
POST /vm-api-autorizacion/oauth/token
Obtener Estado Comercio
POST /obtenerEstadoComercio
Obtener Comercio
POST /obtenerComercio
Obtener Reporte
POST /obtenerReporte
Crear Contrato
POST /crearContrato
Modificar Contrato
POST /modificarContrato
Cancelar Contrato
POST /cancelarContrato
Obtener Contrato
POST /obtenerContrato
Obtener Disponible
POST /obtenerDisponible
Autorización
POST /autorizacion
Reversa
POST /reversa
Estado Transacción
POST /estadoTransaccion
Estado Diario
POST /estadoDiario/{fechaConsulta}
Generar Token
POST /vm-api-autorizacion/oauth/token

Generación de token para el uso de los servicios del api prestamos

Notes

El tipo de autenticaciión es Basic Authenticatión donde el usuario es el compartido personalmente a cada entidad financiera Ejemplo:

Request body

application/x-www-form-urlencoded
Object
usuario
string

usuario para autenticación

Example:
vmas-dev
clave
string

password para autenticación

Example:
********

Responses

200 OK
Body
Object
token
string

Token de autorización

Example:
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHAiOjE1OTc0Mzg1MDYsInVzZXJuYW1lIjoidXNyX2FwcF9sYXRpbl9kZXYiLCJ0b2tlbl90eXBlIjoiQmVhcmVyICJ9.zZtssyslT43-qw90OV_EwQQLtcIyvherBxgN3SzRWe
token_type
string

Tipo de token

Example:
Bearer
exp
string

Tiempo de expiración

Example:
1440
401 Unauthorized
Body
Object
descError
string

Descripción de error

Example:
NO AUTORIZADO
codError
string

Código de error

Example:
13
Examples
{
    "descError": "NO AUTORIZADO",
    "codError": "13"
}
Obtener Estado Comercio
POST /obtenerEstadoComercio

Operación para obtener el estado de comercio

Request headers

Content-Type
string optional
Example:
application/json
Authorization
string optional

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string

Fecha en la que se realiza la petición

Example:
2019-06-15
hora
string

Hora en la que se realiza la petición

Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Provisto por Vendemás

Example:
MO_SB_2019
datos
Object
comercio
Object
codigoComercio
string

Identificador único del comercio en plataforma Vendemás

Example:
843500885
Examples
{
    "fecha": "2019-06-15",
    "hora": "10:00:00",
    "cliente": "MO",
    "programa": "MO_SB_2019",
    "datos": {
        "comercio": {
            "codigoComercio": "843500885"
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha en la que se realiza la petición

Example:
2020-02-25
hora
string

Hora en la que se realiza la petición

Example:
10:15:09
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Provisto por Vendemás

Example:
MO_SB_2019
codigoRespuesta
string

Código de respuesta

Example:
00
mensajeRespuesta
string

Mensaje de respuesta

Example:
EXITO
operacion
string

Tipo de operación

Example:
obtenerEstadoComercio
datos
Object
estadoMonitoreo
string

Estado actual de monitoreo Vendemas

Example:
VALIDADO
estado
string

Estado de comercio en la plataforma Vendemas

Example:
Habilitado
show more
Examples
{
    "fecha": "2020-02-25",
    "hora": "10:15:09",
    "cliente": "MO",
    "programa": "MO_SB_2019",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "obtenerEstadoComercio",
    "datos": {
        "estadoMonitoreo": "VALIDADO",
        "estado": "Habilitado"
    }
}
401 Unauthorized

Token invalido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string
Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Obtener Comercio
POST /obtenerComercio

Operación para obtener datos de comercio Vendemás por identificador único.

Request headers

Content-Type
string optional
Example:
application/json
Authorization
string optional

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string

Fecha de transacción

Example:
2019-06-15
hora
string

Hora de transacción

Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Provisto por Vendemás

Example:
MO_SB_2019
datos
Object
comercio
Object
codigoComercio
string nullable

Identificador único del comercio en plataforma Vendemás

Example:
000894012
documento
string nullable

Número de documento del comercio

Example:
48126179

Responses

200 OK codigoComercio

Respuesta a request con codigo de comercio

Body
Object
fecha
string

Fecha de respuesta de transacción

Example:
2020-02-25
hora
string

Hora de respuesta de transacción

Example:
09:57:52
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Provisto por Vendemás

Example:
MO_SB_2019
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
obtenerComercio
Example:
obtenerComercio
datos
Object
comercio
Object
tipoDocumento
string

Tipo de documento de comercio

Enumeration:
D

DNI

P

PASAPORTE

C

CARNET DE EXTRANJERIA

R

RUC

documento
string

Número de documento del comercio

Example:
20522172023
dniAsociado
string

Número de documento de identidad asociado al representante legal

Example:
48126179
codigoComercio
string

Código único de comercio en plataforma Vendemás

Example:
000894012
nombreLegal
string

Nombre del representante legal o Razon social según sea el caso

Example:
German Luis Chamorro Tapia
nombreComercial
string

Nombre del comercio (según su afiliación)

Example:
AUTOTAXI SATELITAL SAC
giroComercio
string

Giro del comercio

Example:
Servicio de computación, procesamiento de datos
direccion
string

Dirección del comercio

Example:
Vía Expresa Elmer Faucett 2880
departamento
string

Departamento en que se ubica el comercio (según afiliación)

Example:
Callao
provincia
string

Provincia en que se ubica el comercio (según afiliación)

Example:
Callao
distrito
string

Distrito en que se ubica el comercio (según afiliación)

Example:
Callao
telefono
string

Teléfono del comercio

Example:
940403554
email
string

Correo electrónico del comercio

Example:
samuelramostirado@gmail.com
mcc
string

Código de categoría de comercio

Example:
4121
estado
string

Estad del comercio

Example:
Habilitado
flagPrestamoExistente
string

Indica si el comercio tiene un prestamo activo

Enumeration:
1

Presenta prestamo

0

No presenta prestamo

fechaAlta
string

Fecha y hora el cual ingreso el comercio a Vendemas

Example:
2019-11-05 00:12:33
razonSocial
string

Razon social del comercio

Example:
Garcia S.A.C.
show more
Examples
{
    "fecha": "2020-02-25",
    "hora": "09:57:52",
    "cliente": "MO",
    "programa": "MO_SB_2019",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "obtenerComercio",
    "datos": {
        "comercio": {
            "tipoDocumento": "D",
            "documento": "20522172023",
            "dniAsociado": "48126179",
            "codigoComercio": "000894012",
            "nombreLegal": "German Luis Chamorro Tapia",
            "nombreComercial": "AUTOTAXI SATELITAL SAC",
            "giroComercio": "Servicio de computación, procesamiento de datos",
            "direccion": "Vía Expresa Elmer Faucett 2880",
            "departamento": "Callao",
            "provincia": "Callao",
            "distrito": "Callao",
            "telefono": "940403554",
            "email": "samuelramostirado@gmail.com",
            "mcc": "4121",
            "estado": "Habilitado",
            "flagPrestamoExistente": "1",
            "fechaAlta": "2019-11-05 00:12:33",
            "razonSocial": "Garcia S.A.C."
        }
    }
}
200 OK documento

Respuesta a request con número de documento

Body
Object
fecha
string

Fecha de respuesta de transacción

Example:
2020-11-09
hora
string

Hora de respuesta de transacción

Example:
09:31:10
cliente
string

Provisto por Vendemás

Example:
ENTIDAD1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta de transacción

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Example:
obtenerComercio
datos
Object
comercio
Array
Object
tipoDocumento
string

Tipo de documento de comercio

Example:
D
documento
string

Número de documento del comercio

Example:
48126179
dniAsociado
string

Número de documento de identidad asociado al representante legal

Example:
48126179
codigoComercio
string

Código único de comercio en plataforma Vendemás

Example:
845431123
nombreLegal
string

Nombre del representante legal o Razon social según sea el caso

Example:
GERARDO PAOLO DAVILA GARCIA
nombreComercial
string

Nombre del comercio (según su afiliación)

Example:
GERARDO
giroComercio
string

Giro del comercio

Example:
Servicio de computación, procesamiento de datos
direccion
string

Dirección del comercio

Example:
AVENIDA ANTUNEZ DE MAYOLO 1247 3
departamento
string

Departamento en que se ubica el comercio (según afiliación)

Example:
Lima
provincia
string

Provincia en que se ubica el comercio (según afiliación)

Example:
Lima
distrito
string

Distrito en que se ubica el comercio (según afiliación)

Example:
Los Olivos
telefono
string

Teléfono del comercio

Example:
989166938
email
string

Correo electrónico del comercio

Example:
gpdavilag@pucp.pe
mcc
string

Código de categoría de comercio

Example:
7372
estado
string

Mensaje de Respuesta de transacción

Example:
Habilitado
flagPrestamoExistente
integer

Indica si el comercio tiene un prestamo activo

Enumeration:
1

Presenta prestamo

0

No presenta prestamo

fechaAlta
string

Fecha y hora el cual ingreso el comercio a Vendemas

Example:
2019-11-05 00:12:33
razonSocial
string

Razon social del comercio

Example:
Garcia S.A.C.
Examples
{
    "fecha": "2020-11-09",
    "hora": "09:31:10",
    "cliente": "ENTIDAD1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "obtenerComercio",
    "datos": {
        "comercio": [
            {
                "tipoDocumento": "D",
                "documento": "48126179",
                "dniAsociado": "48126179",
                "codigoComercio": "845431123",
                "nombreLegal": "GERARDO PAOLO DAVILA GARCIA",
                "nombreComercial": "GERARDO",
                "giroComercio": "Servicio de computación, procesamiento de datos",
                "direccion": "AVENIDA ANTUNEZ DE MAYOLO 1247 3",
                "departamento": "Lima",
                "provincia": "Lima",
                "distrito": "Los Olivos",
                "telefono": "989166938",
                "email": "gpdavilag@pucp.pe",
                "mcc": "7372",
                "estado": "Habilitado",
                "flagPrestamoExistente": "1",
                "fechaAlta": "2019-11-05 00:12:33",
                "razonSocial": "Garcia S.A.C."
            },
            {
                "tipoDocumento": "D",
                "documento": "48126179",
                "dniAsociado": "48126179",
                "codigoComercio": "847092620",
                "nombreLegal": "GERARDO PAOLO DAVILA GARCIA",
                "nombreComercial": "TEST_VMAS",
                "giroComercio": "AerolÍneas y transporte aÉreo",
                "direccion": "AVENIDA ANTUNEZ DE MAYOLO 1247",
                "departamento": "Lima",
                "provincia": "Lima",
                "distrito": "Lima",
                "telefono": "989166938",
                "email": "test_vmas@yopmail.com",
                "mcc": "4511",
                "estado": "Deshabilitado",
                "fechaAlta": "2022-09-21 00:02:00",
                "razonSocial": "GERARDO PAOLO DAVILA GARCIA",
                "flagPrestamoExistente": 0
            }
        ]
    }
}
401 Unauthorized

Token invalido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta de la petición

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Obtener Reporte
POST /obtenerReporte

Operación para obtener datos de los comercios vendemas y sus movimientos asociados al número de documento. Se muestran datos estadísticos por periodo de consulta diario o mensual.

Request headers

Content-Type
string optional
Example:
application/json
Authorization
string optional
Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string

Fecha de transacción

Example:
2019-06-15
hora
string

Hora de transacción

Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Provisto por Vendemás

Example:
MO_SB_2019
datos
Object
comercio
Object
tipoDocumento
string

Tipo de documento de identidad del comercio

Enumeration:
D

DNI

P

PASAPORTE

C

CARNET DE EXTRANJERIA

R

RUC

documento
string

Número de documento del comercio

Example:
44907911
transaccional
Object
corte
string

Corte de agrupación de datos

Enumeration:
M

MENSUAL

D

DIARIO

show more
Examples
{
    "fecha": "2019-06-15",
    "hora": "10:00:00",
    "cliente": "MO",
    "programa": "MO_SB_2019",
    "datos": {
        "comercio": {
            "tipoDocumento": "R",
            "documento": "20522172023"
        },
        "transaccional": {
            "corte": "M"
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Example:
2020-02-25
hora
string

Hora de respuesta de transacción

Example:
10:11:33
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Código de Respuesta de transacción

Example:
MO_SB_2019
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
obtenerReporte
Example:
obtenerReporte
datos
Array
Object
comercio
Object
tipoDocumento
string

Tipo de documento de identidad del comercio

Enumeration:
D

DNI

P

PASAPORTE

C

CARNET DE EXTRANJERIA

R

RUC

documento
string

Número de documento del comercio

Example:
20522172023
dniAsociado
string

Número de documento de identidad asociado al representante legal

Example:
48126179
codigoComercio
string

Código único de comercio en plataforma Vendemás

Example:
000894012
nombreLegal
string

Nombre del representante legal o Razon social según sea el caso

Example:
Gerardo Garcia Davila
nombreComercial
string

Nombre del comercio (según su afiliación)

Example:
CARRION SAC
giroComercio
string

Giro del comercio

Example:
Servicio de computación, procesamiento de datos
direccion
string

Dirección del comercio

Example:
Vía Expresa Covida 4569
departamento
string

Departamento en que se ubica el comercio (según afiliación)

Example:
Callao
provincia
string

Provincia en que se ubica el comercio (según afiliación)

Example:
Callao
distrito
string

Distrito en que se ubica el comercio (según afiliación)

Example:
Callao
telefono
string

Teléfono del comercio

Example:
999111333
email
string

Correo electrónico del comercio

Example:
samuelramostirado@gmail.com
mcc
string

Código de categoría de comercio

Example:
4212
estado
string

Mensaje de Respuesta de transacción

Example:
Habilitado
flagPrestamoExistente
string

Indica si el comercio tiene un prestamo activo

Enumeration:
1

Presenta prestamo

0

No presenta prestamo

fechaAlta
string

Fecha y hora el cual ingreso el comercio a Vendemas

Example:
2019-11-05 00:12:33
razonSocial
string

Razon social del comercio

Example:
Garcia S.A.C.
transaccional
Object
corte
string

Corte de agrupación de datos

Enumeration:
M

MENSUAL

D

DIARIO

fechaCalculo
string

Fecha de petición del reporte

Example:
20200401
reporte
Array
Object
periodo
string

Fecha de transasccion

Example:
2020-02-25
trxTotal
string

Número de transacciones en el periodo

Example:
2
volTotal
string

Volumen total en el periodo

Example:
769.8
Examples
{
    "fecha": "2020-02-25",
    "hora": "10:11:33",
    "cliente": "MO",
    "programa": "MO_SB_2019",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "obtenerReporte",
    "datos": [
        {
            "comercio": {
                "tipoDocumento": "R",
                "documento": "20522172023",
                "dniAsociado": "48126179",
                "codigoComercio": "000894012",
                "nombreLegal": "Gerardo Garcia Davila",
                "nombreComercial": "CARRION SAC",
                "giroComercio": "Servicio de computación, procesamiento de datos",
                "direccion": "Vía Expresa Covida 4569",
                "departamento": "Callao",
                "provincia": "Callao",
                "distrito": "Callao",
                "telefono": "999111333",
                "email": "samuelramostirado@gmail.com",
                "mcc": "4212",
                "estado": "Habilitado",
                "flagPrestamoExistente": "0",
                "fechaAlta": "2019-11-05 00:12:33",
                "razonSocial": "Garcia S.A.C."
            },
            "transaccional": {
                "corte": "M",
                "fechaCalculo": "20200401",
                "reporte": [
                    {
                        "periodo": "2020-02",
                        "trxTotal": "2",
                        "volTotal": "769.8"
                    }
                ]
            }
        }
    ]
}
401 Unauthorized

Token invalido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de respuesta a la petición

Example:
2023-04-25
hora
string

Hora de respuesta a la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string
Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Crear Contrato
POST /crearContrato

Operación para creación de contrato de definición de límites de flujo con comercio. El serial enviado en la respuesta de la ejecución se usará para identificar en qué contexto de acuerdos se ejecutarán las operaciones de cash in / cash out.

Request headers

Content-Type
string required
Default:
application/json
Authorization
string required

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string required

Fecha de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string required

Hora de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string required

Provisto por Vendemás

Example:
CLIENTE1
programa
string required

Provisto por Vendemás

Example:
PROGRAMA1
datos
Object
comercio
Object required
codigoComercio
string required

Identificador único de comercio en plataforma Vendemás

Example:
123456789
tokenComercio
string required

Token de comercio logueado en app Vendemás para limite de tiempo de consumo de creación de contrato

Example:
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHAiOjE1Nzk2NDMyOTQsInVzZXJuYW1lIjoiYXBwX2dlb191c2VyIiwidG9rZW5fdHlwZSI6IkJlYXJlciAifQ.aOfCcvIi1hBafbdgqQQmOmzAlAPpmbvYNVVdNeoxxCo
contrato
Object
inicio
string required

Fecha de inicio de operaciones con comercio en contexto de crédito

Pattern: YYYY-MM-DD
Example:
2019-07-01
fin
string required

Fecha de fin de operaciones con comercio en contexto de crédito

Pattern: YYYY-MM-DD
Example:
2020-06-30
limite
number required

Monto máximo de la sumatoria de todos los recaudos que se han realizado

Example:
4000
monto
number

monto del préstamo

Example:
1000
datoAdicional1
string

Dato adicional 1

datoAdicional2
string

Dato adicional 2

show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "datos": {
        "comercio": {
            "codigoComercio": "123456789",
            "tokenComercio": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHAiOjE1Nzk2NDMyOTQsInVzZXJuYW1lIjoiYXBwX2dlb191c2VyIiwidG9rZW5fdHlwZSI6IkJlYXJlciAifQ.aOfCcvIi1hBafbdgqQQmOmzAlAPpmbvYNVVdNeoxxCo"
        },
        "contrato": {
            "inicio": "2019-07-01",
            "fin": "2020-06-30",
            "limite": 4000,
            "monto": 1000,
            "datoAdicional1": "",
            "datoAdicional2": ""
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string

Hora de respuesta de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
CLIENTE1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
crearContrato
Example:
crearContrato
datos
Object
comercio
string

Código de comercio

Example:
987654321
contrato
Object
idContrato
integer

Identificador secuencial del contrato

Example:
1
token
string

Serial de identificación del contrato para operaciones en contexto del crédito

Example:
MjUv213MDQvMjAyMzRBRDFQUk9HUkFNQTE4NDU0MzExMjMyMDIzLTA0LTEyMjAyNS0xMi0xNTI0NTAw
inicio
string

Fecha de inicio de operaciones con comercio en contexto de crédito

Pattern: YYYY-MM-DD
Example:
2019-07-01
fin
string

Fecha de fin de operaciones con comercio en contexto de crédito

Pattern: YYYY-MM-DD
Example:
2020-06-30
limite
string

limite de contrato

Example:
4500
monto
number

Monto del prestamo configurado con el comercio

Example:
1000
datoAdicional1
string

Dato adicional 1

datoAdicional2
string

Dato adicional 2

totalIn
number

Monto total inyectado sobre el contrato

Example:
0
totalOut
number

Monto total recaudado sobre el contrato

Example:
0
estado
string

estado del contrato. Siempre se creará como activo

Default:
ACTIVO
Example:
ACTIVO
show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "crearContrato",
    "datos": {
        "comercio": "987654321",
        "contrato": {
            "idContrato": 1,
            "token": "MjUv213MDQvMjAyMzRBRDFQUk9HUkFNQTE4NDU0MzExMjMyMDIzLTA0LTEyMjAyNS0xMi0xNTI0NTAw",
            "inicio": "2019-07-01",
            "fin": "2020-06-30",
            "limite": "4500",
            "monto": 1000,
            "datoAdicional1": "",
            "datoAdicional2": "",
            "totalIn": 1,
            "totalOut": 1,
            "estado": "ACTIVO"
        }
    }
}
401 Unauthorized

Token invalido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Modificar Contrato
POST /modificarContrato

Operación que permite modificar un contrato. Sólo se modificará los valores que esten completados. Por ejemplo:

Sólo se modificara el campo fecha fin

{ “fechaInicio” : “”, “fechaFin” : “2027-02-05”, “montoContrato”: “”, “montoTotal”: “” }

Sólo se modificara el campo monto contrato y el monto total

{ “fechaInicio” : “”, “fechaFin” : “”, “montoContrato”: “4000”, “montoTotal”: “6500” }

Request body

Object
fecha
string

Fecha en la que se realiza la petición

Example:
2020-09-16
hora
string

Hora en que se realiza la petición

Example:
11:17:30
cliente
string

Provisto por Vendemas

Example:
ENTIDAD1
programa
string

Provisto por Vendemas

Example:
PROGRAMA1
datos
Object
contratoToken
string

ID Unico de contrato creado en la plataforma de Vendemas

Example:
MTIvMDQvMjAyMzEyOjA2OjIzRU5USURBRDFQUk9HUkFNQTE4NDU0MzExMjMyMDIzLTA0LTEyMjAyNS0xMi0xNTI0NTAw
fechaInicio
string nullable

Fecha de inicio del contrato a modificar

Example:
2024-04-04
fechaFin
string nullable

Fecha de fin del contrato a modificar

Example:
2027-02-05
montoContrato
string nullable

Monto del prestamo realizado al comercio

Example:
5000
montoTotal
string nullable

Monto máximo de la sumatoria de todos los recaudos que se han realizado

Example:
12540
show more

Responses

200 OK

Respuesta exitosa

Body
Object
fecha
string

Fecha en la que se realiza la petición

Example:
2019-07-15
hora
string

Hora en que se realiza la petición

Example:
10:00:00
cliente
string

Provisto por Vendemas

Example:
CLIENTE1
programa
string

Provisto por Vendemas

Example:
PROGRAMA1
codigoRespuesta
string

Código de respuesta

Example:
00
mensajeRespuesta
string

Mensaje de respuesta

Example:
EXITO
operacion
string

Operación realizada

Example:
modificarContrato
401 Unauthorized

Token invalido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Cancelar Contrato
POST /cancelarContrato

Operación para ejecutar depósitos o retiros al flujo transaccional del comercio (cash in / cash out).

Request headers

Content-Type
string required
Default:
application/json
Authorization
string required

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string required

Fecha de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string required

Hora de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string required

Provisto por Vendemás

Example:
CLIENTE1
programa
string required

Provisto por Vendemás

Example:
PROGRAMA1
datos
Object
contratoToken
string

Token generado en la creación del contrato con el comercio

Example:
NQAvADEANwAvADIAMABNAE8ATQBPAF8AUwBCAF8AMgAwADEAOQA4ADQAMAA3ADgANgA5ADUANwAyADAAMgAwAC0AMAA1AC0AMQA3ADIAMAAyADAALQAwADYALQAxADYAMQAxADEANQAuADgAMgA
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "datos": {
        "contratoToken": "NQAvADEANwAvADIAMABNAE8ATQBPAF8AUwBCAF8AMgAwADEAOQA4ADQAMAA3ADgANgA5ADUANwAyADAAMgAwAC0AMAA1AC0AMQA3ADIAMAAyADAALQAwADYALQAxADYAMQAxADEANQAuADgAMgA"
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string

Hora de respuesta de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
CLIENTE1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
cancelarContrato
Example:
cancelarContrato
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "cancelarContrato"
}
401 Unauthorized

Token invalido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Obtener Contrato
POST /obtenerContrato

Operación para obtener datos de contrato.

Request headers

Content-Type
string required
Default:
application/json
Authorization
string required

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string required

Fecha de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string required

Hora de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string required

Provisto por Vendemás

Example:
CLIENTE1
programa
string required

Provisto por Vendemás

Example:
PROGRAMA1
datos
Object
contrato
Object
codigo
string

Identificador único de comercio/recaudo en plataforma Vendemás.

Example:
ABC123456
partner
string

Identificador del partner en plataforma Vendemás (provisto por operación Listado de Partners)

Example:
PARTNER1
programa
string

Identificador del programa del partner en plataforma Vendemás (provisto por operación Listado de Partners)

Example:
PROGRAMA1
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "datos": {
        "contrato": {
            "codigo": "ABC123456",
            "partner": "PARTNER1",
            "programa": "PROGRAMA1"
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string

Hora de respuesta de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
CLIENTE1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
obtenerContrato
Example:
obtenerContrato
datos
Object
contrato
Object
idContrato
integer

Identificador secuencial del contrato

Example:
1
token
string

Serial de identificación del contrato para operaciones en contexto del crédito

Example:
48d85571-11eb-4fd5-a2ba-71e345d133f3
inicio
string

Fecha de inicio de operaciones con comercio/recaudo en contexto de crédito/deuda

Pattern: YYYY-MM-DD
Example:
2019-07-01
fin
string

Fecha de fin de operaciones con comercio/recaudo en contexto de crédito/deuda

Pattern: YYYY-MM-DD
Example:
2020-06-30
datoAdicional1
string

Dato adicional 1

datoAdicional2
string

Dato adicional 2

totalIn
number

Monto total inyectado sobre el contrato

Example:
0
totalOut
number

Monto total descontado sobre el contrato

Example:
0
estado
string

estado del contrato

Default:
ACTIVO
Example:
ACTIVO
tipo
string

Tipo de contrato según partner

Enumeration:
NOMINADO

Contrato establecido a un comercio

partner
string

Partner de crédito/recaudo

Example:
PARTNER1
programa
string

Programa del crédito/recaudo

Example:
PROGRAMA1
totalDeuda
number

Monto total de la deuda del contrato reportado por el partner

Example:
1000
codigo
string

Identificador único de comercio/recaudo en plataforma Vendemás.

Example:
ABC123456
show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "obtenerContrato",
    "datos": {
        "contrato": {
            "idContrato": 1,
            "token": "48d85571-11eb-4fd5-a2ba-71e345d133f3",
            "inicio": "2019-07-01",
            "fin": "2020-06-30",
            "datoAdicional1": "",
            "datoAdicional2": "",
            "totalIn": 1,
            "totalOut": 1,
            "estado": "ACTIVO",
            "tipo": "NOMINADO",
            "partner": "PARTNER1",
            "programa": "PROGRAMA1",
            "totalDeuda": 1000,
            "codigo": "ABC123456"
        }
    }
}
401 Unauthorized

Token inválido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Si el API demora en responder más de 29 segundos

Body
Object
message
string

Mensaje de respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Obtener Disponible
POST /obtenerDisponible

Operación para obtener saldo disponible del flujo del comercio para retirar en el día

Request headers

Content-Type
string optional
Example:
application/json
Authorization
string optional

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string

Fecha de transacción

Example:
2020-02-07
hora
string

Hora de transacción

Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Provisto por Vendemás

Example:
MO_SB_2019
datos
Object
comercio
Object
codigoComercio
string

Identificador único del comercio en plataforma Vendemás

Example:
844979720
Examples
{
    "fecha": "2020-02-07",
    "hora": "10:00:00",
    "cliente": "MO",
    "programa": "MO_SB_2019",
    "datos": {
        "comercio": {
            "codigoComercio": "844979720"
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Example:
2020-02-25
hora
string

Hora de respuesta de transacción

Example:
09:59:56
cliente
string

Provisto por Vendemás

Example:
MO
programa
string

Provisto por Vendemás

Example:
MO_SB_2019
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
obtenerDisponible
Example:
obtenerDisponible
datos
Object
comercio
Object
codigoComercio
string

Código único de comercio en plataforma Vendemás

Example:
844979720
disponible
integer

Monto disponible del flujo en tránsito del comercio. Nota: Este sólo representa el 60% del monto transaccionado del comercio

Example:
240
show more
Examples
{
    "fecha": "2020-02-25",
    "hora": "09:59:56",
    "cliente": "MO",
    "programa": "MO_SB_2019",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "obtenerDisponible",
    "datos": {
        "comercio": {
            "codigoComercio": "844979720"
        },
        "disponible": 240
    }
}
401 Unauthorized

Token invalido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje de respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Autorización
POST /autorizacion

Operación para ejecutar depósitos o retiros al flujo transaccional del comercio cash in (desembolsos) y cash out (recaudos)

Request headers

Content-Type
string required
Default:
application/json
Authorization
string required

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string required

Fecha de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string required

Hora de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string required

Provisto por Vendemás

Example:
CLIENTE1
programa
string required

Provisto por Vendemás

Example:
PROGRAMA1
datos
Object
contrato
Object required
token
string required

Serial generado en la creación del contrato con el comercio

Example:
a91ce883-464f-4a78-95cc-9ffd9fe64f04
transaccion
Object
tipo
string

Dirección de flujo de dinero

Enumeration:
IN

Cash In: inyección de dinero al flujo del comercio (Desembolso)

OUT

Cash Out: descuento de dinero del flujo del comercio (Recaudo)

Example:
IN
idOriginal
string

Id de transacción en plataforma del cliente

Example:
4675956759786976
monto
number

Monto en operación en moneda soles

Example:
100
comercioOrigen
string

código de comercio para inyección/descuento de monto de transacción según sea IN/OUT

Example:
123456789
show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "datos": {
        "contrato": {
            "token": "a91ce883-464f-4a78-95cc-9ffd9fe64f04"
        },
        "transaccion": {
            "tipo": "IN",
            "idOriginal": "4675956759786976",
            "monto": 1000,
            "comercioOrigen": "123456789"
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string

Hora de respuesta de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
CLIENTE1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
autorizacion
Example:
autorizacion
datos
Object
contrato
Object
idContrato
integer

Identificador secuencial del contrato

Example:
1
token
string

Serial de identificación del contrato para operaciones en contexto del crédito

Example:
48d85571-11eb-4fd5-a2ba-71e345d133f3
inicio
string

Fecha de inicio de operaciones con comercio/recaudo en contexto de crédito/deuda

Pattern: YYYY-MM-DD
Example:
2019-07-01
fin
string

Fecha de fin de operaciones con comercio/recaudo en contexto de crédito/deuda

Pattern: YYYY-MM-DD
Example:
2020-06-30
datoAdicional1
string

Dato adicional 1

datoAdicional2
string

Dato adicional 2

totalIn
integer

Monto total inyectado sobre el contrato

Example:
0
totalOut
integer

Monto total descontado sobre el contrato

Example:
0
estado
string

estado del contrato

Example:
ACTIVO
tipo
string

Tipo de contrato según partner

Enumeration:
NOMINADO

Contrato establecido a un comercio

partner
string

Provisto por Vendemás

Example:
VENDEMAS1
programa
string

Provisto por Vendemás

Example:
CLIENTE1
totalDeuda
integer

Monto total de la deuda del contrato reportado por el partner

Example:
1000
codigo
string

Identificador único de comercio/recaudo en plataforma Vendemás.

Example:
123456789
transaccion
Object
tipo
string

Dirección de flujo de dinero

Enumeration:
IN

Cash In: inyección de dinero al flujo del comercio

OUT

Cash Out: descuento de dinero del flujo del comercio

idOriginal
string

Id de transacción en plataforma del cliente (referencia si se requiere reversar)

Example:
4675956759786976
idTransaccion
string

Id de transacción en plataforma Vendemás

Example:
4356728356475246
monto
integer

Monto en operación en moneda soles

Example:
100
estado
string

Estado de la transacción

Enumeration:
PENDIENTE

Transacción ingresada pero no ejecutada, no es estado final

PAGADO

Transacción ejecutada de Cash In / Cash Out según sea el caso

RECHAZADO

Transacción rechazada

EXTORNADO

Transaccion extornada

motivoEstado
string

Descripción del motivo del estado

fechaTransaccion
string

Fecha en que se ingresa la transacción

Example:
2019-07-01 10:00:00
fechaActualizacion
string

Fecha en que se actualiza el estado final de la transacción (APROBADA/DENEGADA/REVERSADA)

Example:
2019-07-01 16:00:00
comercioOrigen
string

Comercio al que se descontará/inyectará flujo out/in de la transacción

Example:
123456789
show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "autorizacion",
    "datos": {
        "contrato": {
            "idContrato": 1,
            "token": "48d85571-11eb-4fd5-a2ba-71e345d133f3",
            "inicio": "2019-07-01",
            "fin": "2020-06-30",
            "datoAdicional1": "",
            "datoAdicional2": "",
            "totalIn": 1000,
            "totalOut": 0,
            "estado": "ACTIVO",
            "tipo": "NOMINADO",
            "partner": "VENDEMAS1",
            "programa": "CLIENTE1",
            "totalDeuda": 1000,
            "codigo": "123456789"
        },
        "transaccion": {
            "tipo": "IN",
            "idOriginal": "4675956759786976",
            "idTransaccion": "4356728356475246",
            "monto": 1000,
            "estado": "PENDIENTE",
            "motivoEstado": "",
            "fechaTransaccion": "2019-07-01 10:00:00",
            "fechaActualizacion": "2019-07-01 16:00:00",
            "comercioOrigen": "123456789"
        }
    }
}
401 Unauthorized

Token inválido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string
Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Reversa
POST /reversa

Operación para reversar transacciones de Cash In/ Cash Out. La ejecución exitosa de la reversa dependerá de los límites de cortes diarios que se definan para la ejecución de las transacciones.

Request headers

Content-Type
string required
Default:
application/json
Authorization
string required

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string required

Fecha de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string required

Hora de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string required

Provisto por Vendemás

Example:
CLIENTE1
programa
string required

Provisto por Vendemás

Example:
PROGRAMA1
datos
Object
contrato
Object required
token
string required

Serial generado en la creación del contrato con el comercio

Example:
a91ce883-464f-4a78-95cc-9ffd9fe64f04
transaccion
Object

Datos de la transacción original a reversar

tipo
string

Dirección de flujo de dinero

Enumeration:
IN

Cash In: inyección de dinero al flujo del comercio

OUT

Cash Out: descuento de dinero del flujo del comercio

Example:
IN
idOriginal
string

Id de transacción en plataforma del cliente

Example:
4675956759786976
monto
number

Monto en operación en moneda soles

Example:
100
comercioOrigen
string

Identificador del comercio de origen

Example:
046090272
referencia
string

Id de transacción original a reversar

Example:
4675956759786975
show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "datos": {
        "contrato": {
            "token": "a91ce883-464f-4a78-95cc-9ffd9fe64f04"
        },
        "transaccion": {
            "tipo": "IN",
            "idOriginal": "4675956759786976",
            "monto": 100,
            "comercioOrigen": "046090272",
            "referencia": "4675956759786975"
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string

Hora de respuesta de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
CLIENTE1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
reversa
Example:
reversa
datos
Object
contrato
Object
idContrato
string

Identificador secuencial del contrato

Example:
1
token
string

Serial de identificación del contrato para operaciones en contexto del crédito

Example:
87d50500-4939-4f93-a8e3-9fab7716eeb7
inicio
string

Fecha de inicio de operaciones con comercio en contexto de crédito

Example:
2019-07-01
fin
string

Fecha de fin de operaciones con comercio en contexto de crédito

Example:
2020-06-30
limite
integer

Monto máximo de operación con el comercio (Σ in / Σ out)

Example:
1000
datoAdicional1
string

Dato adicional 1

datoAdicional2
string

Dato adicional 2

totalOut
integer

Monto total descontado sobre el contrato

Example:
100
totalIn
integer

Monto total inyectado sobre el contrato

Example:
500
estado
string
Enumeration:
ACTIVO
INACTIVO
Example:
ACTIVO
transaccion
Object
tipo
string

Dirección de flujo de dinero

Enumeration:
IN

Cash In: inyección de dinero al flujo del comercio

OUT

Cash Out: descuento de dinero del flujo del comercio

idOriginal
string

Id de transacción en plataforma del cliente (referencia si se requiere reversar)

Example:
4675956759786976
idTransaccion
string

Id de transacción en plataforma Vendemás

Example:
4356728356475246
monto
integer

Monto en operación en moneda soles

Example:
100
motivoEstado
string

Descripción del motivo del estado

fechaTransaccion
string

Fecha en que se ingresa la transacción

Example:
2019-07-01 10:00:00
fechaActualizacion
string

Fecha en que se actualiza el estado final de la transacción

Example:
2019-07-01 16:00:00
referencia
string

Id de transacción original a reversar

Example:
4675956759786975
show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "reversa",
    "datos": {
        "contrato": {
            "idContrato": "1",
            "token": "87d50500-4939-4f93-a8e3-9fab7716eeb7",
            "inicio": "2019-07-01",
            "fin": "2020-06-30",
            "limite": 1000,
            "datoAdicional1": "",
            "datoAdicional2": "",
            "totalOut": 100,
            "totalIn": 500,
            "estado": "ACTIVO"
        },
        "transaccion": {
            "tipo": "IN",
            "idOriginal": "4675956759786976",
            "idTransaccion": "4356728356475246",
            "monto": 100,
            "motivoEstado": "",
            "fechaTransaccion": "2019-07-01 10:00:00",
            "fechaActualizacion": "2019-07-01 16:00:00",
            "referencia": "4675956759786975"
        }
    }
}
401 Unauthorized

Token inválido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje de respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
Estado Transacción
POST /estadoTransaccion

Operación para obtener el estado de transacción ejecutada de cash IN/OUT

Request headers

Content-Type
string required
Default:
application/json
Authorization
string required

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string required

Fecha de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string required

Hora de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string required

Provisto por Vendemás

Example:
CLIENTE1
programa
string required

Provisto por Vendemás

Example:
PROGRAMA1
datos
Object
contrato
Object required
token
string required

Serial generado en la creación del contrato con el comercio

Example:
a91ce883-464f-4a78-95cc-9ffd9fe64f04
transaccion
Object
idOriginal
string

Id de transacción en plataforma del cliente

Example:
4675956759786976
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "datos": {
        "contrato": {
            "token": "a91ce883-464f-4a78-95cc-9ffd9fe64f04"
        },
        "transaccion": {
            "idOriginal": "4675956759786976"
        }
    }
}

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string

Hora de respuesta de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
CLIENTE1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
estadoTransaccion
Example:
estadoTransaccion
datos
Object
contrato
Object
idContrato
string

Identificador secuencial del contrato

Example:
1
token
string

Serial de identificación del contrato para operaciones en contexto del crédito

Example:
87d50500-4939-4f93-a8e3-9fab7716eeb7
inicio
string

Fecha de inicio de operaciones con comercio en contexto de crédito

Example:
2019-07-01
fin
string

Fecha de fin de operaciones con comercio en contexto de crédito

Example:
2020-06-30
limite
integer

Monto máximo de operación con el comercio (Σ in / Σ out)

Example:
1000
datoAdicional1
string

Dato adicional 1

datoAdicional2
string

Dato adicional 2

totalIn
integer

Monto total inyectado sobre el contrato

Example:
500
totalOut
integer

Monto total descontado sobre el contrato

Example:
100
estado
string
Enumeration:
ACTIVO
INACTIVO
Example:
ACTIVO
transaccion
Object
tipo
string

Dirección de flujo de dinero

Enumeration:
IN

Cash In: inyección de dinero al flujo del comercio

OUT

Cash Out: descuento de dinero del flujo del comercio

idOriginal
string

Id de transacción en plataforma del cliente (referencia si se requiere reversar)

Example:
4675956759786976
idTransaccion
string

Id de transacción en plataforma Vendemás

Example:
4356728356475246
monto
integer

Monto en operación en moneda soles

Example:
100
estado
string

Estado de la transacción

Enumeration:
PENDIENTE

Transacción ingresada pero no ejecutada.No es estado final

PAGADO

Transacción ejecutada de Cash In / Cash Out según sea el caso. Es estado final

RECHAZADO

Transacción rechazada. Es estado final

EXTORNADO

Transaccion extornada. Es estado final

motivoEstado
string

Descripción del motivo del estado

fechaTransaccion
string

Fecha en que se ingresa la transacción

Example:
2019-07-01 10:00:00
fechaActualizacion
string

Fecha en que se actualiza el estado final de la transacción (APROBADA/DENEGADA/REVERSADA)

Example:
2019-07-01 16:00:00
referencia
string

Id de transacción original reversada

Example:
4675956759786975
show more
Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "estadoTransaccion",
    "datos": {
        "contrato": {
            "idContrato": "1",
            "token": "87d50500-4939-4f93-a8e3-9fab7716eeb7",
            "inicio": "2019-07-01",
            "fin": "2020-06-30",
            "limite": 1000,
            "datoAdicional1": "",
            "datoAdicional2": "",
            "totalIn": 500,
            "totalOut": 100,
            "estado": "ACTIVO"
        },
        "transaccion": {
            "tipo": "OUT",
            "idOriginal": "4675956759786976",
            "idTransaccion": "4356728356475246",
            "monto": 100,
            "estado": "EXTORNADO",
            "motivoEstado": "",
            "fechaTransaccion": "2019-07-01 10:00:00",
            "fechaActualizacion": "2019-07-01 16:00:00",
            "referencia": "4675956759786975"
        }
    }
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje de respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
401 Unauthorized

Token inválido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Estado Diario
POST /estadoDiario/{fechaConsulta}

Operación para obtener los estados de transacciones ejecutadas en fecha de consulta

Path variables

fechaConsulta
string YYYY-MM-DD required

Fecha de consulta de estado de transacciones

Example:
2019-07-01

Request headers

Content-Type
string required
Default:
application/json
Authorization
string required

Token de autenticación

Example:
Bearer eyJraWQiOiJmWk1tV3pZR0RBckxHektvalNCK2w3SjFhMnNPXC9zQnNwOTlNNmNuM3F5MD0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzOTFmZmU1MC1mODc3LTRjMjktOWEwOS00YjdjN2JlZTQ1ZDgiLCJjb2duaXRvOmdyb3VwcyI6WyJtcG9zLWFkbWluIl0sImV2ZW50X2lkIjoiNDg0NmEyNTgtOGMyNC0xMWU4LTk4YzMtMmZmYTRiNzlkYjlhIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJhd3MuY29nbml0by5zaWduaW4udXNlci5hZG1pbiIsImF1dGhfdGltZSI6MTUzMjA5NDgwOSwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWRwLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tXC91cy1lYXN0LTFfMmNKMVNlMWZJIiwiZXhwIjoxNTMyMDk4NDA5LCJpYXQiOjE1MzIwOTQ4MDksImp0aSI6ImU2MDg0ZTI5LTk3NTYtNGVlNi1iZjMzLTY4YWRjNzk2MDBmMiIsImNsaWVudF9pZCI6IjEwbHYwNjE3bzVkaWM1MWVic25xZWlpamI3IiwidXNlcm5hbWUiOiJnaWFuY2FnYWxsYXJkb0BnbWFpbC5jb20ifQ.PjvPa2NCYuW962kAhL9HZnOKKjMNPL0O-jIVUDev4zhvUqMJUPTLKvVCwqJlXRM37oZD7tmkZBkRl7jWCZwXS2GpPALg5iHa6KvjD-9ml-7mGnl8kSOglqOe6U3my26L5f9QL7BQfoYI9SWA1Rcdh6ZRQsScPxdh9VEZdFEMOVvSTGT0pNBNymBag29cgkHVrdM-OyaxFaMdRqnlEGteJFtoanEXcu52PdiRrm5Y5aQStNLWqEnA1eKhHNPgTgXBIXLVNtLKDJ60Yd-3PADcylDxg8dSsZla5b9jstqUB-EihIkO-aJ4PcEUDYkLFjCPcGQQN5CgJtXuxDXK5hHLHg

Request body

Object
fecha
string required

Fecha de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string required

Hora de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string required

Provisto por Vendemás

Example:
CLIENTE1
programa
string required

Provisto por Vendemás

Example:
PROGRAMA1
Examples

Responses

200 OK
Body
Object
fecha
string

Fecha de respuesta de transacción

Pattern: YYYY-MM-DD
Example:
2019-07-15
hora
string

Hora de respuesta de transacción

Pattern: hh:mm:ss
Example:
10:00:00
cliente
string

Provisto por Vendemás

Example:
CLIENTE1
programa
string

Provisto por Vendemás

Example:
PROGRAMA1
codigoRespuesta
string

Código de Respuesta de transacción

Example:
00
mensajeRespuesta
string

Mensaje de Respuesta

Example:
EXITO
operacion
string

Nombre de operación ejecutada

Default:
estadoDiario
Example:
estadoDiario
datos
Object
transaccion
Array
Object
tipo
string

Dirección de flujo de dinero

Enumeration:
IN

Cash in: inyección de dinero al flujo del comercio

OUT

Cash out: descuento de dinero del flujo del comercio

idOriginal
string

Id de la transacción en plataforma del cliente (referencia si se requiere reversar)

Example:
4675956759786976
idTransaccion
string

Id de transacción en plataforma Vendemas

Example:
4356728356475246
monto
number

Monto en operació en monedas soles

estado
string

Estado de la transaccion

Enumeration:
PENDIENTE

Transacción ingresada pero no ejecutada, no es estado final

PAGADO

Transacción ejecutada de Cash In/Cash Out según sea el caso. Es un estado final

RECHAZADAO

Transacción rechazada. Es un estado final

REVERSADO

Transacción Reversada. Es un estado final

motivoEstado
string

Descripcion del motivo del estado

fechaTransaccion
string

Fecha en la que se ingresa la transaccion

Example:
2019-07-01 10:00:00
fechaActualizacion
string

Fecha en la que se actualiza el estado final de la transaccion

Example:
2019-07-01 16:00:00
referencia
string

Id de transaccion original reversada

comercioOrigen
string

Codigo del comercio

Examples
{
    "fecha": "2019-07-15",
    "hora": "10:00:00",
    "cliente": "CLIENTE1",
    "programa": "PROGRAMA1",
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "operacion": "estadoDiario",
    "datos": {
        "transaccion": [
             {
                "tipo": "IN",
                "idOriginal": "2675956759786946",
                "idTransaccion": "3356728356445246",
                "monto": 1500,
                "estado": "PAGADO",
                "motivoEstado": "",
                "fechaTransaccion": "2019-07-01 10:00:00",
                "fechaActualizacion": "2019-07-01 16:00:00",
                "referencia": "",
                "comercioOrigen": "846393244"
            },
            {
                "tipo": "OUT",
                "idOriginal": "4675956759786946",
                "idTransaccion": "4356728356445246",
                "monto": 50,
                "estado": "PAGADO",
                "motivoEstado": "",
                "fechaTransaccion": "2019-07-01 10:00:00",
                "fechaActualizacion": "2019-07-01 16:00:00",
                "referencia": "",
                "comercioOrigen": "843633491"
            },
            {
                "tipo": "OUT",
                "idOriginal": "4675956759786976",
                "idTransaccion": "4356728356475246",
                "monto": 15,
                "estado": "REVERSADO",
                "motivoEstado": "",
                "fechaTransaccion": "2019-07-01 10:00:00",
                "fechaActualizacion": "2019-07-01 16:00:00",
                "referencia": "",
                "comercioOrigen": "847225920"
            }
        ]
    }
}
401 Unauthorized

Token inválido

Body
Object
codigoRespuesta
string

Código de respuesta

Example:
12
fecha
string

Fecha de la respuesta de la petición

Example:
2023-04-25
hora
string

Hora de la respuesta de la petición

Example:
17:20:30
mensajeRespuesta
string

Mensaje de respuesta

Example:
TOKEN INVÁLIDO O EXPIRADO
Examples
{
    "codigoRespuesta": "12",
    "fecha": "2023-04-25",
    "hora": "17:20:30",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO"
}
504 Gateway Timeout

Sí el API se demora más de 29 segundos en responder

Body
Object
message
string

Mensaje de respuesta

Example:
Endpoint request timed out
Examples
{
    "message": "Endpoint request timed out"
}
APIS Prestamistas
Endpoint Fintech
POST /dominio-fintech/token
Notificar Interes Comercio
POST /dominio-fintech/notify/merchant
Endpoint Fintech
POST /dominio-fintech/token

Operación propia de la fintech para desarrollo de prestamos y generación de url marketplace

Request headers

Content-Type
string optional
Example:
application/json

Request body

Object
external_id
string

codigo único de comercio vendemas

Example:
844805145

Responses

200 OK
Body
Object
url
string

Webview propio de fintech

Example:
https://webview-ejemplo.fintech.com/?token=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHA
token
string

Token unico generado por el fintech

Example:
eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHA

Examples

POST http://prestamos.vendemasdev.pe/dominio-fintech/token HTTP/1.1 

Content-Type: application/json

{
    "external_id": "844805145"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "url": "https://webview-ejemplo.fintech.com/?token=eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHA",
    "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJodHRwczovL3d3dy52ZW5kZW1hcy5jb20ucGUiLCJleHA"
}
Notificar Interes Comercio
POST /dominio-fintech/notify/merchant

Operación propia de la fintech para recibir notificación de interes de un comercio

Request body

Object
codigoComercio
string

Código del comercio a notificar

Example:
843634989

Responses

200 OK
Body
Object
responseMessage
string

Mensaje de éxito

Example:
success
responseCode
string

Código de éxito

Default:
00
500 Internal Server Error
Body
Object
responseCode
string

Cualquier código de respuesta diferente a 00

responseMessage
string

Mensaje de error