• V1.0

Descripción del Servicio

Wepay4u expone un kit de servicios RESTFULL, los mismos que cuentan con URL’s previsibles y orientados a recursos. Utilizando códigos de respuesta HTTP para indicar errores de API, soportando la autenticación HTTP y los verbos HTTP estándares como GET, POST, PATCH y DELETE.

Descripción del Proceso Cash-IN

El proceso CASH-IN tiene como finalidad, ayudar a las empresas con la recaudación y cobranza a sus clientes.

El cual, a través de nuestras API’s, el usuario podrá CREAR sus transacciones, revisar la lista de sus operaciones creadas y el detalle de cada una de ellas, junto con otros métodos que se describirán más adelante.

Autenticación

Para poder iniciar con las operaciones a través de los servicios API, el usuario deberá configurar la autenticación Basic HTTP. Haciendo uso de la llave que se encuentra dentro del  Backoffice/Configuración/API, enviando dentro del parámetro USER.

Ejemplo Postman:

Métodos disponibles

Los métodos expuestos por Wepay4u para el proceso Cash-IN son:

Validación del servicio

Con este servicio el usuario podrá verificar si el servicio de Wepay4u está disponible para ser consumido, es como hacer un ping al servicio.

Creación de transacción​

Con este servicio el usuario podrá generar nuevas órdenes de pagos.

Parámetros:​

Con este servicio el usuario podrá generar nuevas órdenes de pagos.

Parámetro Descripción Estructura Ejemplo
MerchantSalesID(*)
Código único del comercio paraidentificar la transacción.
string(100)
COBRANZA10101
Detalle
Descripción de la cobranza,puede ser el número de factura odescripción del producto y/oservicio.
string(150)
Mensualidad 07-2020
Amount(*)
Monto a transferir.
decimal(18.2)
120.00
CountryCode(*)
País de la transacción.
string(3)
ISO-4217:PER,ECU,COL
CurrencyCode(*)
Moneda de la transacción
string(3)
ISO-4217: PEN, USD, CUP
CreationDate(*)
Fecha y hora en la que se realizala petición.
date
ISO 8601: yyyy-MM-ddThh:mm:ss 2020-07-18 06:05:55
TimeExpired(*)
Tiempo de expiración en minutos de la transacción.
string(3)
60
OkURL(*)
URL donde se redirige al cliente una vez que realiza el depósito.
string(180)
https://mydomain.com/urlok
ErrorURL(*)
URL donde se redirige al cliente si la operación expira.
string(100)
https://mydomain.com/urlerror
Channel(*)
Canal de pago
string(100)
ONLINE, CASH
Filter
Filtros para la transacción.
string(10)
Filter.Country
Filtro si se requiere que el pago se realice en un país en específico.
string(3)
ISO-4217: PER,ECU,COL
Filter.Currency
Filtro si se requiere que el pago se realice en una moneda en específico.
string(3)
ISO-4217: PEN, USD, CUP
Filter.Bank
Filtro si se requiere que el pago se realice en un banco en específico.
string(20)
1001,1002,1003
Filter.Channel
Filtro si se requiere que el pago se realice a través de un canal en específico.
string(20)
ONLINE, CASH
Customer
Datos del pagador.
Customer.FirstName(*)
Nombres del pagador.
string(80)
SEBASTIAN
Customer.LastName(*)
Apellido del pagador.
string(4)
RODRIGUEZ VARGAS
Customer.DocNumber(*)
Número de documento delpagador.
string(20)
DNI, RUC, C.EXT, PAS
Customer.DocType(*)
Tipo de documento del pagador.
string(20)
2013365485215852125485
Customer.CountryCode(*)
Tipo de cuenta bancaria.
string(15)
AHORRO, CORRIENTE,CTS
Customer.Email(*)
Email del beneficiario.
string(100)
my_email@gmail.com
Customer.Address
Dirección del pagador.
string(150)
Av. Principal 123 Lima Perú
Customer.Mobile(*)
Celular del beneficiario.
string(20)
945325852
Customer.Phone
Teléfono del beneficiario.
string(20)
012566585

Ejemplo Request:​

  • Perú
  • Brasil
  • Colombia
{
    "MerchantSalesID": "TXPEN-20",
    "Detalle": "PAGO PEN FACTURA 200",
    "Amount": 80.00,
    "CountryCode": "PER",
    "CurrencyCode": "PEN",
    "CreationDate": "2020-01-12 06:05:55",
    "TimeExpired": 15000,
    "OkURL": "http://www.urlok.com",
    "ErrorURL": "http://www.urlerror.com",
    "Channel": "Online - Cash - Debito - Credito",
    "Filter": {
        "Country": "PER",
        "Currency": "PEN",
        "Bank": "1001",
        "Channel": "ONLINE, CASH"
    },
    "Customer": {
        "FirstName": "EDDY",
        "LastName": "YALICO",
        "DocNumber": "47053118",
        "DocType": "DNI",
        "CountryCode": "PER",
        "Email": "eryj@gmail.com",
        "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos",
        "Mobile": "945347889",
        "Phone": "945347889"
    }
}
{
    "MerchantSalesID": "TXPEN-20",
    "Detalle": "PAGO PEN FACTURA 200",
    "Amount": 80.00,
    "CountryCode": "PER",
    "CurrencyCode": "PEN",
    "CreationDate": "2020-01-12 06:05:55",
    "TimeExpired": 15000,
    "OkURL": "http://www.urlok.com",
    "ErrorURL": "http://www.urlerror.com",
    "Channel": "Online - Cash - Debito - Credito",
    "Filter": {
        "Country": "PER",
        "Currency": "PEN",
        "Bank": "1001",
        "Channel": "ONLINE, CASH"
    },
    "Customer": {
        "FirstName": "EDDY",
        "LastName": "YALICO",
        "DocNumber": "47053118",
        "DocType": "DNI",
        "CountryCode": "PER",
        "Email": "eryj@gmail.com",
        "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos",
        "Mobile": "945347889",
        "Phone": "945347889"
    }
}
{
    "MerchantSalesID": "TXPEN-20",
    "Detalle": "PAGO PEN FACTURA 200",
    "Amount": 80.00,
    "CountryCode": "PER",
    "CurrencyCode": "PEN",
    "CreationDate": "2020-01-12 06:05:55",
    "TimeExpired": 15000,
    "OkURL": "http://www.urlok.com",
    "ErrorURL": "http://www.urlerror.com",
    "Channel": "Online - Cash - Debito - Credito",
    "Filter": {
        "Country": "PER",
        "Currency": "PEN",
        "Bank": "1001",
        "Channel": "ONLINE, CASH"
    },
    "Customer": {
        "FirstName": "EDDY",
        "LastName": "YALICO",
        "DocNumber": "47053118",
        "DocType": "DNI",
        "CountryCode": "PER",
        "Email": "eryj@gmail.com",
        "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos",
        "Mobile": "945347889",
        "Phone": "945347889"
    }
}

Ejemplo Response:

  • Perú
  • Brasil
  • Colombia
{
    "PublicID": "Em_dev_2eb4e59fq0bec8",
    "Token": "0ad965cd0d33ee6bd0c9075b19e3d4b2737ae681",
    "Created": "2020-01-12 06:05:55",
    "Expiration": "2020-08-01 03:36:27",
    "MerchantCode": 1001,
    "UrlRedirect": "https://dev-payment.wepay4u.com/checkout/0ad965cd0d33ee6bd0c9075b19e3d4b2737ae681",
    "PaymentCode": "4705311826",
    "Transaction": {
        "MerchantSaleID": "TXPEN-20",
        "Amount": "TXPEN-20",
        "CurrencyCode": "PEN",
        "Creation": "2020-01-12 06:05:55",
        "TimeExpired": "2020-08-01 03:36:27",
        "OkURL": "http://www.urlok.com",
        "ErrorURL": "http://www.urlerror.com",
        "Status": 10,
        "Customer": {
            "FullName": "YALICO JARA EDILBERTO ROGELIO",
            "FirstName": "EDILBERTO ROGELIO",
            "LastName": "YALICO JARA",
            "DocNumber": "47053118",
            "CountryCode": "PER",
            "Email": "eryj@gmail.com",
            "Phone": "945347889",
            "Mobile": "945347889",
            "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
        }
    }
}
{
    "PublicID": "Em_dev_2eb4e59fq0bec8",
    "Token": "0ad965cd0d33ee6bd0c9075b19e3d4b2737ae681",
    "Created": "2020-01-12 06:05:55",
    "Expiration": "2020-08-01 03:36:27",
    "MerchantCode": 1001,
    "UrlRedirect": "https://dev-payment.wepay4u.com/checkout/0ad965cd0d33ee6bd0c9075b19e3d4b2737ae681",
    "PaymentCode": "4705311826",
    "Transaction": {
        "MerchantSaleID": "TXPEN-20",
        "Amount": "TXPEN-20",
        "CurrencyCode": "PEN",
        "Creation": "2020-01-12 06:05:55",
        "TimeExpired": "2020-08-01 03:36:27",
        "OkURL": "http://www.urlok.com",
        "ErrorURL": "http://www.urlerror.com",
        "Status": 10,
        "Customer": {
            "FullName": "YALICO JARA EDILBERTO ROGELIO",
            "FirstName": "EDILBERTO ROGELIO",
            "LastName": "YALICO JARA",
            "DocNumber": "47053118",
            "CountryCode": "PER",
            "Email": "eryj@gmail.com",
            "Phone": "945347889",
            "Mobile": "945347889",
            "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
        }
    }
}
{
    "PublicID": "Em_dev_2eb4e59fq0bec8",
    "Token": "0ad965cd0d33ee6bd0c9075b19e3d4b2737ae681",
    "Created": "2020-01-12 06:05:55",
    "Expiration": "2020-08-01 03:36:27",
    "MerchantCode": 1001,
    "UrlRedirect": "https://dev-payment.wepay4u.com/checkout/0ad965cd0d33ee6bd0c9075b19e3d4b2737ae681",
    "PaymentCode": "4705311826",
    "Transaction": {
        "MerchantSaleID": "TXPEN-20",
        "Amount": "TXPEN-20",
        "CurrencyCode": "PEN",
        "Creation": "2020-01-12 06:05:55",
        "TimeExpired": "2020-08-01 03:36:27",
        "OkURL": "http://www.urlok.com",
        "ErrorURL": "http://www.urlerror.com",
        "Status": 10,
        "Customer": {
            "FullName": "YALICO JARA EDILBERTO ROGELIO",
            "FirstName": "EDILBERTO ROGELIO",
            "LastName": "YALICO JARA",
            "DocNumber": "47053118",
            "CountryCode": "PER",
            "Email": "eryj@gmail.com",
            "Phone": "945347889",
            "Mobile": "945347889",
            "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
        }
    }
}

Listar Transacciones Creadas

Con este servicio el usuario podrá consultar la lista de sus operaciones, el servicio retornará las últimas 1000 transacciones generadas.

Ejemplo:

  • Perú
  • Brasil
  • Colombia
{
    "Records": 204,
    "Data": [
        {
            "ID": "Em_dev_1f51cf0dceputg",
            "MerchantSalesID": "TXPEN-2",
            "Amount": "80.00",
            "CurrencyCode": "PEN",
            "Creation": "2020-01-12",
            "TimeExpired": "2020-06-06 02:49:02",
            "OkURL": "http://www.urlok.com",
            "ErrorURL": "TXPEN-2",
            "Status": {
                "LastStatus": 0,
                "IsPaid": false,
                "IsNotified": false,
                "IsExpired": true,
                "IsSettled": false
            },
            "Token": "7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "UrlRedirect": "http://dev-payment.wepay4u.com/checkout/7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "Customer": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "FirstName": "EDILBERTO ROGELIO",
                "LastName": "YALICO JARA",
                "DocNumber": "47053118",
                "DocType": "DNI",
                "Email": "eryj@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
            }
        }
    ]
}
{
    "Records": 204,
    "Data": [
        {
            "ID": "Em_dev_1f51cf0dceputg",
            "MerchantSalesID": "TXPEN-2",
            "Amount": "80.00",
            "CurrencyCode": "PEN",
            "Creation": "2020-01-12",
            "TimeExpired": "2020-06-06 02:49:02",
            "OkURL": "http://www.urlok.com",
            "ErrorURL": "TXPEN-2",
            "Status": {
                "LastStatus": 0,
                "IsPaid": false,
                "IsNotified": false,
                "IsExpired": true,
                "IsSettled": false
            },
            "Token": "7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "UrlRedirect": "http://dev-payment.wepay4u.com/checkout/7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "Customer": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "FirstName": "EDILBERTO ROGELIO",
                "LastName": "YALICO JARA",
                "DocNumber": "47053118",
                "DocType": "DNI",
                "Email": "eryj@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
            }
        }
    ]
}
{
    "Records": 204,
    "Data": [
        {
            "ID": "Em_dev_1f51cf0dceputg",
            "MerchantSalesID": "TXPEN-2",
            "Amount": "80.00",
            "CurrencyCode": "PEN",
            "Creation": "2020-01-12",
            "TimeExpired": "2020-06-06 02:49:02",
            "OkURL": "http://www.urlok.com",
            "ErrorURL": "TXPEN-2",
            "Status": {
                "LastStatus": 0,
                "IsPaid": false,
                "IsNotified": false,
                "IsExpired": true,
                "IsSettled": false
            },
            "Token": "7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "UrlRedirect": "http://dev-payment.wepay4u.com/checkout/7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "Customer": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "FirstName": "EDILBERTO ROGELIO",
                "LastName": "YALICO JARA",
                "DocNumber": "47053118",
                "DocType": "DNI",
                "Email": "eryj@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
            }
        }
    ]
}

Detalle de una Transacción

Con este servicio el usuario podrá ver el detalle de una transacción específica, para este objetivo, deberá enviar el parámetro “MerchantSalesID” dentro de la URL.

Si el MerchantSalesID
en consulta tiene más de una transacción generada, este se listará en la respuesta.

Ejemplo:

  • Perú
  • Brasil
  • Colombia
{
    "Records":3,
    "Data": [
        {
            "ID": "Em_dev_1f51cf0dceputg",
            "MerchantSalesID": "TXPEN-2",
            "Amount": "80.00",
            "CurrencyCode": "PEN",
            "Creation": "2020-01-12",
            "TimeExpired": "2020-06-06 02:49:02",
            "OkURL": "http://www.urlok.com",
            "ErrorURL": "TXPEN-2",
            "Status": {
                "LastStatus": 0,
                "IsPaid": false,
                "IsNotified": false,
                "IsExpired": true,
                "IsSettled": false
            },
            "Token": "7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "UrlRedirect": "http://dev-payment.wepay4u.com/checkout/7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "Customer": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "FirstName": "EDILBERTO ROGELIO",
                "LastName": "YALICO JARA",
                "DocNumber": "47053118",
                "DocType": "DNI",
                "Email": "eryj@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
            }
        }
    ]
}
{
    "Records":3,
    "Data": [
        {
            "ID": "Em_dev_1f51cf0dceputg",
            "MerchantSalesID": "TXPEN-2",
            "Amount": "80.00",
            "CurrencyCode": "PEN",
            "Creation": "2020-01-12",
            "TimeExpired": "2020-06-06 02:49:02",
            "OkURL": "http://www.urlok.com",
            "ErrorURL": "TXPEN-2",
            "Status": {
                "LastStatus": 0,
                "IsPaid": false,
                "IsNotified": false,
                "IsExpired": true,
                "IsSettled": false
            },
            "Token": "7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "UrlRedirect": "http://dev-payment.wepay4u.com/checkout/7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "Customer": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "FirstName": "EDILBERTO ROGELIO",
                "LastName": "YALICO JARA",
                "DocNumber": "47053118",
                "DocType": "DNI",
                "Email": "eryj@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
            }
        }
    ]
}
{
    "Records":3,
    "Data": [
        {
            "ID": "Em_dev_1f51cf0dceputg",
            "MerchantSalesID": "TXPEN-2",
            "Amount": "80.00",
            "CurrencyCode": "PEN",
            "Creation": "2020-01-12",
            "TimeExpired": "2020-06-06 02:49:02",
            "OkURL": "http://www.urlok.com",
            "ErrorURL": "TXPEN-2",
            "Status": {
                "LastStatus": 0,
                "IsPaid": false,
                "IsNotified": false,
                "IsExpired": true,
                "IsSettled": false
            },
            "Token": "7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "UrlRedirect": "http://dev-payment.wepay4u.com/checkout/7942a10e5189cebb0e045d625d8816e5cc12c14b",
            "Customer": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "FirstName": "EDILBERTO ROGELIO",
                "LastName": "YALICO JARA",
                "DocNumber": "47053118",
                "DocType": "DNI",
                "Email": "eryj@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Teniente Jimenez Chavez 182 - Chorrillos"
            }
        }
    ]
}