Cash in

Cash out

Plugins
  • V1.0

Descripción del Servicio

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

Descripción del proceso Cash-Out

El proceso CASH-OUT tiene como finalidad, ayudar a las empresascon la dispersión de dinero a sus clientes, proveedores y trabajadores.

El cual a través de nuestras API, 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:

  • 1. Validación del servicio
  • 2. Creación de transacción
  • 3. Listar transacciones creadas
  • 4. Detalle de una transacción
  • 5. Listar bancos disponibles
  • GET- validate_service
  • POST- payout_order
  • GET- Payout_order
  • GET - payout_order/{merchant_reference}
  • GET- list_banks

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.

  • Endpoint
  • Verbo HTTP
  • Authorization
  • Parámetros
  • https://stg-payout.wepay4u.com/api/v1/validate_service
  • GET
  • Basic Auth
  • Ninguno
  • Endpoint:
    https://stg-payout.wepay4u.com/api/v1/validate_service
  • Verbo HTTP: GET
  • Authorization: Basic Auth
  • Parámetros: Ninguno

Creación de transacción​

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

  • Endpoint
  • Verbo HTTP
  • Authorization
  • https://stg-payout.wepay4u.com/api/v1/payout_order
  • POST
  • Basic Auth
  • Endpoint:
    https://stg-payout.wepay4u.com/api/v1/payout_order
  • Verbo HTTP: POST
  • Authorization: Basic Auth

Parámetros:​

Parámetro Descripción Estructura Ejemplo
Parámetro
MerchantSalesID(*)
Descripción
Código único del comercio para identificar la transacción.
Estructura
string(100)
Ejemplo
PAGOFACT1010
Parámetro
Amount(*)
Descripción
Monto a transferir.
Estructura
decimal(18.2)
Ejemplo
120.00
Parámetro
CountryCode(*)
Descripción
País de la transacción.
Estructura
string(3)
Ejemplo
ISO-4217:PER,ECU,COL
Parámetro
CurrencyCode(*)
Descripción
Moneda de la transacción
Estructura
string(3)
Ejemplo
ISO-4217: PEN, USD, CUP
Parámetro
CreationDate(*)
Descripción
Fecha y hora en la que se realizala petición.
Estructura
date
Ejemplo
ISO 8601: yyyy-MM-ddThh:mm:ss 2020-07-18 06:05:55
Parámetro
Customer
Descripción
Datos del beneficiario (Información personal y bancaria)
Estructura
Ejemplo
Parámetro
Customer.Info
Descripción
Datos personales del beneficiario
Estructura
Ejemplo
Parámetro
Customer.Info.FirstName(*)
Descripción
Nombres del beneficiario
Estructura
string(100)
Ejemplo
SEBASTIAN
Parámetro
Customer.Info.LastName(*)
Descripción
Apellido del beneficiario.
Estructura
string(100)
Ejemplo
RODRIGUEZ VARGAS
Parámetro
Customer.Info.DocType(*)
Descripción
Tipo de documento del beneficiario.
Estructura
string(10)
Ejemplo
DNI, RUC, C.EXT, PAS
Parámetro
Customer.Info.DocNumber(*)
Descripción
Número de documento beneficiario.
Estructura
string(10)
Ejemplo
47359618
Parámetro
Customer.Info.Email(*)
Descripción
Email del beneficiario.
Estructura
string(50)
Ejemplo
myemail@gmail.com
Parámetro
Customer.Info.Phone(*)
Descripción
Teléfono del beneficiario
Estructura
string(20)
Ejemplo
0198754258
Parámetro
Customer.Info.Mobile(*)
Descripción
Celular del beneficiario
Estructura
string(20)
Ejemplo
964585354
Parámetro
Customer.Info.Address(*)
Descripción
Dirección del beneficiario
Estructura
string(100)
Ejemplo
Jr. Los faisanes 184 - Lima Lima
Parámetro
Customer.Bank
Descripción
Datos Bancarios del beneficiario
Estructura
Ejemplo
Parámetro
Customer.Bank.BankCode(*)
Descripción
Código de banco, revisar servicio list_banks
Estructura
string(4)
Ejemplo
1001,1002,1003,1004
Parámetro
Customer.Bank.AccountBankNumber(*)
Descripción
Número de cuenta bancaria del beneficiario
Estructura
string(20)
Ejemplo
1234567892345
Parámetro
Customer.Bank.AccountBankNumberCCI(*)
Descripción
Número de cuenta interbancaria del beneficiario
Estructura
string(20)
Ejemplo
2013365485215852125485
Parámetro
Customer.Bank.TypeAccountBank(*)
Descripción
Tipo de cuenta bancaria
Estructura
string(20)
Ejemplo
AHORRO, CORRIENTE, CTS

Ejemplo Request:​

  • Perú
  • Brasil
  • Colombia 
{
    "MerchantReference": "TESTPROD2",
    "Amount": 1.00,
    "CountryCode": "PER",
    "CurrencyCode": "PEN",
    "CreationDate": "2020-07-18 06:05:55",
    "Customer": {
        "Info": {
            "FirstName": "EDILBERTO",
            "LastName": "YALICO JARA",
            "DocType": "DNI",
            "CountryCode": "PER",
            "DocNumber": "47053118",
            "Email": "eryj20000@gmail.com",
            "Phone": "945347889",
            "Mobile": "945347889",
            "Address": "Jr. Los faisanes 184 - Lima Lima"
        },
        "Bank": {
            "BankCode": "1003",
            "AccountBankNumber": "8983140980309",
            "TypeAccountBank": "AHORRO"
        }
    }
}
{
    "MerchantReference": "TESTPROD2",
    "Amount": 1.00,
    "CountryCode": "PER",
    "CurrencyCode": "PEN",
    "CreationDate": "2020-07-18 06:05:55",
    "Customer": {
        "Info": {
            "FirstName": "EDILBERTO",
            "LastName": "YALICO JARA",
            "DocType": "DNI",
            "CountryCode": "PER",
            "DocNumber": "47053118",
            "Email": "eryj20000@gmail.com",
            "Phone": "945347889",
            "Mobile": "945347889",
            "Address": "Jr. Los faisanes 184 - Lima Lima"
        },
        "Bank": {
            "BankCode": "1003",
            "AccountBankNumber": "8983140980309",
            "TypeAccountBank": "AHORRO"
        }
    }
}
{
    "MerchantReference": "TESTPROD2",
    "Amount": 1.00,
    "CountryCode": "PER",
    "CurrencyCode": "PEN",
    "CreationDate": "2020-07-18 06:05:55",
    "Customer": {
        "Info": {
            "FirstName": "EDILBERTO",
            "LastName": "YALICO JARA",
            "DocType": "DNI",
            "CountryCode": "PER",
            "DocNumber": "47053118",
            "Email": "eryj20000@gmail.com",
            "Phone": "945347889",
            "Mobile": "945347889",
            "Address": "Jr. Los faisanes 184 - Lima Lima"
        },
        "Bank": {
            "BankCode": "1003",
            "AccountBankNumber": "8983140980309",
            "TypeAccountBank": "AHORRO"
        }
    }
}

Ejemplo Response:

  • Perú
  • Brasil
  • Colombia 
{
    {
        "PublicID": "Em_dev_bce649d4pi9q63hy",
        "MerchantReference": "TESTPROD2",
        "TxCreation": "2020-07-18",
        "Amount": "1.00",
        "CurrencyCode": "PEN",
        "LastStatus": 10,
        "Customer": {
                "Info": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "eryj20000@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "8983140980309",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}
{
    {
        "PublicID": "Em_dev_bce649d4pi9q63hy",
        "MerchantReference": "TESTPROD2",
        "TxCreation": "2020-07-18",
        "Amount": "1.00",
        "CurrencyCode": "PEN",
        "LastStatus": 10,
        "Customer": {
                "Info": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "eryj20000@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "8983140980309",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}
{
    {
        "PublicID": "Em_dev_bce649d4pi9q63hy",
        "MerchantReference": "TESTPROD2",
        "TxCreation": "2020-07-18",
        "Amount": "1.00",
        "CurrencyCode": "PEN",
        "LastStatus": 10,
        "Customer": {
                "Info": {
                "FullName": "YALICO JARA EDILBERTO ROGELIO",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "eryj20000@gmail.com",
                "Phone": "945347889",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "8983140980309",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}

Listar Transacciones Creadas

Con este servicio el usuario podrá consultar la lista de sus operaciones, el servicio retornará las últimas 1000 transacciones generadas.
  • Endpoint
  • Verbo HTTP
  • Authorization
  • Parámetros
  • https://stg-payout.wepay4u.com/api/v1/payout_order
  • GET
  • Basic Auth
  • Ninguno
  • Endpoint:
    https://stg-payout.wepay4u.com/api/v1/payout_order
  • Verbo HTTP: GET
  • Authorization: Basic Auth
  • Parámetros : Ninguno

Ejemplo:

  • Perú
  • Brasil
  • Colombia 
{
    {
        "PublicID": "Em_dev_66c617965w4htdg6",
        "MerchantReference": "TESTCAHOUT_0000002",
        "TxCreation": "2019-10-20",
        "Amount": "80.00",
        "CurrencyCode": "PEN",
        "LastStatus": 12,
        "Customer": {
                "Info": {
                "FullName": "FRANCO RUIZ ALEX",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "email@dominio.com",
                "Phone": "01-2585965",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "10070000283871",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}
{
    "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"
            }
        }
    ]
}
{
    {
        "PublicID": "Em_dev_66c617965w4htdg6",
        "MerchantReference": "TESTCAHOUT_0000002",
        "TxCreation": "2019-10-20",
        "Amount": "80.00",
        "CurrencyCode": "PEN",
        "LastStatus": 12,
        "Customer": {
                "Info": {
                "FullName": "FRANCO RUIZ ALEX",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "email@dominio.com",
                "Phone": "01-2585965",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "10070000283871",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}

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 la referencia en consulta tiene más de una transacción generada, este se listará en la respuesta.
  • Endpoint
  • Verbo HTTP
  • Authorization
  • Parámetros
  • https://stg-payout.wepay4u.com/api/v1/payout_order/{MerchantReference}
  • GET
  • Basic Auth
  • MerchantReference
  • Endpoint:
    https://stg-payout.wepay4u.com/api/v1/payout_order/{MerchantReference}
  • Verbo HTTP: GET
  • Authorization: Basic Auth
  • Parámetros: MerchantReference

Ejemplo:

  • Perú
  • Brasil
  • Colombia 
{
    {
        "PublicID": "Em_dev_66c617965w4htdg6",
        "MerchantReference": "TESTCAHOUT_0000002",
        "TxCreation": "2019-10-20",
        "Amount": "80.00",
        "CurrencyCode": "PEN",
        "LastStatus": 12,
        "Customer": {
                "Info": {
                "FullName": "FRANCO RUIZ ALEX",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "email@dominio.com",
                "Phone": "01-2585965",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "10070000283871",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}
{
    {
        "PublicID": "Em_dev_66c617965w4htdg6",
        "MerchantReference": "TESTCAHOUT_0000002",
        "TxCreation": "2019-10-20",
        "Amount": "80.00",
        "CurrencyCode": "PEN",
        "LastStatus": 12,
        "Customer": {
                "Info": {
                "FullName": "FRANCO RUIZ ALEX",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "email@dominio.com",
                "Phone": "01-2585965",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "10070000283871",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}
{
    {
        "PublicID": "Em_dev_66c617965w4htdg6",
        "MerchantReference": "TESTCAHOUT_0000002",
        "TxCreation": "2019-10-20",
        "Amount": "80.00",
        "CurrencyCode": "PEN",
        "LastStatus": 12,
        "Customer": {
                "Info": {
                "FullName": "FRANCO RUIZ ALEX",
                "DocType": "DNI",
                "DocNumber": "47053118",
                "Email": "email@dominio.com",
                "Phone": "01-2585965",
                "Mobile": "945347889",
                "Address": "Jr. Los faisanes 184 - Lima Lima"
            },
            "BankCode": {
                "CustomerBank": "INTERBANK",
                "CustomerAccountNumber": "10070000283871",
                "CustomerCCI": "00389801314098030948",
                "TypeAccountBank": "AHORRO"
            }
        }
    }
}

Listar bancos disponibles

Con este servicio el usuario podrá saber la lista de bancos y códigos disponibles para la creación de una transacción.
  • Endpoint
  • Verbo HTTP
  • Authorization
  • Parámetros
  • https://stg-payout.wepay4u.com/api/v1/listBanks?country=PER
  • GET
  • Basic Auth
  • Country
  • Endpoint:
    https://stg-payout.wepay4u.com/api/v1/listBanks?country=PER
  • Verbo HTTP: GET
  • Authorization: Basic Auth
  • Parámetros: Country

Ejemplo:

  • Perú
  • Brasil
  • Colombia 
{
    {
        "BankCode": 1081,
        "ShortName": "BCP",
        "CountryCode": "PER"
    },
    {
        "BankCode": 1082,
        "ShortName": "BBVA PERU",
        "CountryCode": "PER"
    },
    {
        "BankCode": 1083,
        "ShortName": "INTERBANK",
        "CountryCode": "PER"
    }
}
{
    {
        "BankCode": 1081,
        "ShortName": "BCP",
        "CountryCode": "PER"
    },
    {
        "BankCode": 1082,
        "ShortName": "BBVA PERU",
        "CountryCode": "PER"
    },
    {
        "BankCode": 1083,
        "ShortName": "INTERBANK",
        "CountryCode": "PER"
    }
}
{
    {
        "BankCode": 1081,
        "ShortName": "BCP",
        "CountryCode": "PER"
    },
    {
        "BankCode": 1082,
        "ShortName": "BBVA PERU",
        "CountryCode": "PER"
    },
    {
        "BankCode": 1083,
        "ShortName": "INTERBANK",
        "CountryCode": "PER"
    }
}