API DOCUMENTACIÓN
Postman collection → OpenAPI spec →

Introduction

Utiliza nuestra API para procesar pagos de forma segura

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {PERSONAL_ACCESS_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Generales

Obtener token de autenticación

POST
https://app.bepay.com.co
/api/v1/get-access-token

Este endpoint permite generar un token de acceso para autenticar al usuario y poder realizar otras solicitudes al API

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": "43|Twf760yNIOzPwU5TOsxqHg8dV6XsaOMkkRaeea8f",
    "message": ""
}
{
    "success": false,
    "message": "Invalid credentials"
}

Obtener listado de cuentas

GET
https://app.bepay.com.co
/api/v1/accounts
requires authentication

Este endpoint devuelve el listado de cuentas relacionado al usuario que realiza la solicitud

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
{
"success": true,
"data": [
    {
        "id": 2,
        "platform": "DEVELOPMENT",
        "banks_account_number": "13616635935",
        "rsa_public_key": "-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAsufUhXQlalV0swvLo8nM
uZ3Poe3GZU+73+hbwVst+9C02Eu31JmPRXdCdDPsOtzJtxPC7xazlvT1+cVEOHNE
UEvtirJE7tim6SIJIAqHpdAEdnvdwYLSADJ836ZSwFZMwqbySDgcjm5543E9rAQ/
kg8z8uotIcJaWZl/PYkE0CePVAW4+nkqogaDb/aL6CaaNWzO5/PHejUfHsaHx9rP
86AvSOPlNCI0noBcdUzpT4pgcuRJocf66eB9gBRTTh8EeU4oPpHD3QAfpBu68n7H
xOPOATYxKyuHGrZAVFRsiLoLZDhRqM3W6ZiVz8Z6v+J08ebVjnHB97f2793NX9JD
qxjoaNh4vNbSQpavHdZqzme6lJtYtCWaBdutn2p97zkNoeN2HjvpaYmqIqEHy1LJ
gUh4VdC3+sxC8gY9uByJCss5UzU2jt5c6Ppm42ztVlrTLX/Rg9N7sDnPw3YRTZfb
IUaqKZtEwIGJ3Nt25RZr/qiavV6R8EgQoE+t+CxXwtthBNhw5nUrCWVWpXqylV5W
0o4rekq3cVmqxfomQXOusDcleoWppTDxuO00QmgTkebwB6b8ZirMf6ss5XJv273Y
nUBFzoz5kOt0JCsC4muwx0SPp0V0SwVOt8+UsTP/E2Gf7kLxeYyTg1uy36ZFczh4
zVk/Y+BEX6p7ODYEolV1yVkCAwEAAQ==
-----END PUBLIC KEY-----
"
    }
],
"message": ""
}
{
    "message": "Unauthenticated."
}

Obtener metodos de pago de una cuenta

POST
https://app.bepay.com.co
/api/v1/accounts/paymentmethods
requires authentication

Este endpoint devuelve el listado de métodos de pago de una cuenta

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": [
        "TC",
        "PSE",
        "WALLETVISA"
    ],
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Obtener monedas disponibles

GET
https://app.bepay.com.co
/api/v1/currencies
requires authentication

Este endpoint devuelve el listado de monedas disponibles

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
{
    "success": true,
    "data": [
        {
            "iso_code": "COP",
            "symbol": "$",
            "decimal_separator": ",",
            "thousand_separator": "."
        }
    ],
    "message": ""
}
{
    "message": "Unauthenticated."
}

Obtener los impuestos disponibles

GET
https://app.bepay.com.co
/api/v1/taxes
requires authentication

Este endpoint devuelve el listado de impuestos disponibles

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
{
    "success": true,
    "data": [
        {
            "type": "IVA",
            "value": "0.00"
        },
        {
            "type": "IVA",
            "value": "5.00"
        },
        {
            "type": "IVA",
            "value": "19.00"
        }
    ],
    "message": ""
}
{
    "message": "Unauthenticated."
}

Obtener paises

GET
https://app.bepay.com.co
/api/v1/countries
requires authentication

Este endpoint devuelve el listado de paises disponibles

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Colombia",
            "code_country": 57
        }
    ],
    "message": ""
}
{
    "message": "Unauthenticated."
}

Obtener regiones

GET
https://app.bepay.com.co
/api/v1/regions/{countryId?}
requires authentication

Este endpoint devuelve el listado de regiones disponibles

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

countryId
integer

Id del país del que se desean obtener las regiones Debe ser un valor devuelto por el endpoint Obtener paises

Example:
48
Example response:
{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Antioquia",
            "code": "ANT",
            "country_id": 48,
            "country_name": "Colombia",
            "country_code": "CO",
        }

        {
            "id": 2,
            "name": "Cundinamarca",
            "code": "CUN",
            "country_id": 48,
            "country_name": "Colombia",
            "country_code": "CO",
        }
    ],
    "message": ""
}
{
    "message": "Unauthenticated."
}

Obtener ciudades

GET
https://app.bepay.com.co
/api/v1/cities/{countryId?}/{regionId?}
requires authentication

Este endpoint devuelve el listado de ciudades disponibles

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

countryId
integer

Id del país del que se desean obtener las ciudades Debe ser un valor devuelto por el endpoint Obtener paises

Example:
48
regionId
integer

Id de la región de la que se desean obtener las ciudades Debe ser un valor devuelto por el endpoint Obtener regiones

Example:
2890
Example response:
{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Medellín",
            "region_id": 2,
            "region_name": "Antioquia",
            "region_code": "ANT",
            "country_id": 48,
            "country_name": "Colombia",
            "country_code": "CO",
        },
        {
            "id": 2,
            "name": "Envigado",
            "region_id": 2,
            "region_name": "Antioquia",
            "region_code": "ANT",
            "country_id": 48,
            "country_name": "Colombia",
            "country_code": "CO",
        }
    ],
    "message": ""
}
{
    "message": "Unauthenticated."
}

Obtener tipos de documentos

GET
https://app.bepay.com.co
/api/v1/documentTypes
requires authentication

Este endpoint devuelve el listado de tipos de documentos disponibles

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "NIT",
            "short_name": "NIT"
        },
        {
            "id": 2,
            "name": "Cédula de ciudadanía",
            "short_name": "CC"
        },
        {
            "id": 3,
            "name": "Cédula de extranjería",
            "short_name": "CE"
        },
        {
            "id": 4,
            "name": "Pasaporte",
            "short_name": "PAS"
        },
        {
            "id": 5,
            "name": "Tarjeta de identidad",
            "short_name": "TI"
        },
        {
            "id": 6,
            "name": "Registro civil de nacimiento",
            "short_name": "RC"
        }
    ],
    "message": ""
}
{
    "message": "Unauthenticated."
}

Obtener bancos PSE

GET
https://app.bepay.com.co
/api/v1/pseBanks
requires authentication

Este endpoint devuelve el listado de bancos disponibles en PSE

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
{
    "success": true,
    "data": [
        {
            "name": "BANCO PSE",
            "code": "1101"
        },
        {
            "name": "BANCO UNION COLOMBIANO",
            "code": "1022"
        }
    ],
    "message": ""
}
{
    "message": "Unauthenticated."
}

Bancos

GET
https://app.bepay.com.co
/api/v1/Banks
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

per_page
integer

records per page

Example:
20
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "success": false,
    "data": null,
    "meta": [],
    "message": "Unauthenticated."
}

Códigos CIIU

GET
https://app.bepay.com.co
/api/v1/ciiuCodes
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

per_page
integer

records per page

Example:
20
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "success": false,
    "data": null,
    "meta": [],
    "message": "Unauthenticated."
}

Obtener balance

POST
https://app.bepay.com.co
/api/v1/account-balance
requires authentication

Obtiene el balance en tiempo real de la cuenta indicada

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:

Cobros

Generar un link de cobro

POST
https://app.bepay.com.co
/api/v1/charges/link
requires authentication

Este endpoint devuelve un link de cobro con el que se puede iniciar una transacción

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}
{
    "success": false,
    "data": [
        "error"
    ],
    "message": "Ocurrió un error generando el recurso"
}

Envia un SMS de cobro

POST
https://app.bepay.com.co
/api/v1/charges/sms
requires authentication

Este endpoint envia un link de cobro por medio de SMS

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}
{
    "success": false,
    "data": [
        "error"
    ],
    "message": "Ocurrió un error generando el recurso"
}

Envia un Whatsapp de cobro

POST
https://app.bepay.com.co
/api/v1/charges/whatsapp
requires authentication

Este endpoint envia un link de cobro por medio de Whatsapp

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}
{
    "success": false,
    "data": [
        "error"
    ],
    "message": "Ocurrió un error generando el recurso"
}

Envia un email de cobro

POST
https://app.bepay.com.co
/api/v1/charges/email
requires authentication

Este endpoint envia un link de cobro por medio de correo electrónico

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}
{
    "success": false,
    "data": [
        "error"
    ],
    "message": "Ocurrió un error generando el recurso"
}

Generar un QR de cobro

POST
https://app.bepay.com.co
/api/v1/charges/qr
requires authentication

Este endpoint devuelve un QR en base64 con el que se puede iniciar una transacción

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5N2RjMWZlMjU1NQ",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2RjMWZlMjU1NQ",
        "qr": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAIAAAAiOjnJAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAXiUlEQVR4nO2dfXRT1ZbA902TUNJCW8ACla9AKXQQhRZ9yAMkMPLE50AZngOIFhDW4ymhuOqgljqjOBYWwwzLIMMstCyBN9KifJQKOHYq+GxZqC3ISHmMKdCWQgv0Ky39TJPc+YO+Z7jnpD259540Ifv3H5t9ztn3ZjfZ99x99gbwP2pqakRZuFwu6oQmk0miabPZqJoWi0WiWVRUpPBybDabvMtxOp3UCZOSkiSaNTU1Co1UHU1vG4A8mKBjIVxAx0K4gI6FcAEdC+GCtrcNYMLlcomiSMpDQkJUX8vTs5i/zenn0B0rISHBN8ufP3+eRW3RokU5OTmk3Ol0ajQyv3Sp17h+/fr169fLHk4lMjLSC7Pux2g0RkVFSYTh4eGMw/3tc4SEhAR5Wy9ekZmZSV2d3MdKSkqiajqdTnc19n0sKuXl5Ux3BwAAioqKWOY0m83sc5IYjUaWVTztY2VmZrIMVwjVfTHGQriAjoVwAR0L4QI6FsIFL7YbWlpalKxkMBgEQVAyg7oovBxVZpC3iiAIBoNB3myiKLa2tiqxJywsjEWN1bFaWlrYn3KpFBQUTJ8+Xd7YuLi45ORkUk56KlWNfGJvbGxk3wWgzvn4448zDldCWVkZeduTkpKOHj0qb8IzZ87MmDFDiUnNzc0svhUYG6Rbt25lURMEYd++faqvvmjRovnz57tLcnNz9+/fr/pCDxIYYyFcQMdCuICOhXABHQvhQmAE73fu3FGSIKDRaAYPHqyiPUiPBIZjrVmzhprdwIjJZDp16pSK9ngiIyNDIqmurt65cyeLJpX09HQVzOoNAsOxAoVly5aNHDnSXbJu3Tqq5oYNG3Q6XfezuVyuwHUsjLEQLqBjIVxAx0K4gI6FcAGDdzW5e/duSUmJvLGyB/ongeFYK1euXLx4sUS4cePGsrIyiTAqKmrXrl0SoV6vl0gMBkNWVhbj6uPGjWPUnDhxIimkLqTVSu/8zJkzGxoaGBfyfwLDsSTJBffYuHEjVXnJkiU9TqjT6VjUVGHevHkRERG+Wct/wBgL4QI6FsIFdCyEC+hYCBcCI3gvKChob2+XN1YUxfz8fEblmJiYCRMmuEvq6upYz48jbrA6lsFgKCgoULJSfHy87LHbt2+Xnd3gcDjmzp3LqGyxWCSOVVZWRh3Ofjf69evHqEliNBrJ5Po+ffrInjA+Pl7h58h4QIjVsQRBkH3G5oEkNDR0ypQpPlhI3ds+cOBA33yOGGMhXEDHQriAjoVwAR0L4YLH4H3Pnj2+tENFesvygoICq9VKyl966SXJW/BPP/2UffeEvJzw8HDylTz78OCFvaKflYCqZjKZGDXZO1OQFf0sFgtVk+xMYTKZlFxOQHSmCIwNUk+MGTPGvQapSCuAe4+xY8e6/7OxsZGjWXKJjY11L3PiqfJlQIAxFsIFdCyEC+hYCBfQsRAuBHbw/vbbbzNqespj9gGMVeMgkA/Ukwh++KQ6aNAgiaShoYEsCvLEE0+QhynYMZvN77zzjkRoMBgkb++Li4upVSGLiookL6F37NjB2NVCIdRSkbW1tT5Ymh0t+Sn6IWQRUVUIiGtnxN+uBWMshAvoWAgX0LEQLqBjIVzQLly40Dcrbdy4UfJ4dfDgwezsbN+srjqMJfk4QX5q06ZN27Bhg7ukrKwsNTWVHJuamirpIZCbm/vJJ5+Qmrt3746OjnaXvPnmm9RX44cPH5bdOFIpBQUFknfynvoVKiEqKqqNgKppNptZmvF5ym6gUl5eLlnaU79C0kgq7EunpaVJLPeUHJGXlyfR9FTGoqqqSqJJbdIBAA6HQ6IZ2BukVEJDQ93/2dnZ2YureyIkJISlVKQaFvUOGGMhXEDHQriAjoVwAR0L4YLvgndPDxSqM3r0aBa1EydOnDhxQiJMTU1V2HeeEfYqgaqzZs0aXyzjJHA4HFTN5ORkUpmRvLw86pxWq1WimZaWpsR4qprJZJKo2Ww2qqZXhynI1cndCpfLRap5OkxBYjQaJWM97UGQ2w2iKJJLe1W4QdF2A7mv5enjAQAem2AK52Q8TNFblguCoLBhsRLLe23TEmMshBPoWAgX0LEQLnj3VNhNECMbHnMqQYk9D9K1KJzBC8fav3+/6q3b4+LiSCGnRGSWVdavX0/mrVM1yZDcq5x3xmsk+wywU1payn57qb0LYmJiGIeT+ONLaKvVyjuDOyIior6+XiKsqKgYNWoUqbx3715qBwMl3L59u8eX0Jw4ePDg008/7S7Jzs5eunQp4/DKysqwsLAe1TDGQriAjoVwAR0L4QI6FsIFrY8TLBkhrVI91PXqwnncJdXnZJ9Q3aWps3nxGov91alCTp8+TQrb2tp6zPoVRXHOnDmkfMiQIQcOHHCXNDY2RkZGkprUa6TaEwxQ78bx48clVQgSExMVNe9ITk4m35+rjqfshra2NhVXUZ7dEAyQ2Q1UEhISyLEYYyFcQMdCuKAVRVFhwtADjGiriqj64Q8T9YP6CloBmjvF2ja40gQ/1TqbOjxmrSEAoEWvkiCKLuHKGSjKhpKTQl35WID/fFKq4wThQoP+eAUcuCJa6/3xsbrX8e5dIWMVa4PBwLI7YLfb2Q/7dnR0dHR0MCpLEAShf//+PappBIi/+6Pw3qNQdal7zRAQE6PsiVHwzmThqyr9++fFwpvoXvfB5esqKyuLpUf8nj17Vq9ezcMACSaT6dSpU+4ScrthymDdRzNhcpQ8/xAOV+peK3TeuKvo91HJOY6dO3cyTsiu+e677w4cOLDHpTds2EA22vDH7Abf848J+s2JnTpBdvaSuGi4ffbvNL8v1B0qlf/VtWPHDnmRSW1tLdVdJk2atGrVKndJYWEhVXPNmjWPPPKIjKUBYNu2baQw2J8KNQJkztZvm2JX4FVdROlcn5sc7z8pv/3pg0RQO5YgCJmz9ati7epNKaZP7Ng1C30ruB3rnx7XrRyjold18UpcB35vBa9jzRqm++dJ6nvVPdIn2n83tncSRP2EYA3eO9szZ4oh7PrPb4e+EfDdH8H6DdsA8aPpzu9uhXj1nHj9+nUWNa1W+/DDDzPOWVFRIVtzxIgRkoeJ6upqu53y1zhy5EipkZ667CnBaDSyqMXFxZGr37p1a8uWLYwLMRrft29ficRQtHdMOL2SAJ0nXoD+g6GimNmxIErn2j5N/w9fOUkjc3JyqBkT1Ix7ErKBgMFgoN4K6m4OVXPixImksKqqaujQoe6St956i3qgxuFwhITc93eqTUlJoRnvC2bMmCEphgle9iYxm80yTpGL9lZd/r97O0oGz4/snDpUt3z58oiICHd5Tk6OugsZDAbycywtLaWeGoqPjycPU6hrDwRnjCUUH4Rm3zR6ETdODtI3ZkEZY/1wgC4XNDBkPBgioa4CbDd7mCTyYQCA1noQAYY9Co4OuHkRXNKI6tlh9pamarj/GysYCDrHEtvvCtY/Uf4jfg68+BEMGg0AIIpQchL2roBmD52P9AbYWgkgwPf/BY/Mg7CBAADVf4ZdC+DOFXfFEAD9hcMw/MFp68VI0P0UCte+Ayfx1iVmAqw9DoNGg8sJLXUgCDDxt7DmUM/vUn/1IggasFUBAAz9G1j5R1JFe5leG+zBhv6NVVxcTApDQ0Nlv06qq6tT0gKOHarl7gy5+OUwUvr066ALhTulsH0ONFTCpCT4wxGIewpGT4VrZ7ub7tJXsGsBODrg2XRY8D6MngrRsdIvres/iA67oNV7fzW9zM2bN2/e7CkkAACAH3/8USKhOJbT6aR26EtOTt63b58M+wDg/Pnzc+fOZVQ+duwYo6bkkVAURarl7ux6SvcKWaUxdjoAwNcWaKgEALiQA5XnYUQijPl1D451dh84OrrGzn8PBA1Ej5U4ltDZDjVXYWj8XyVvvPHGa6+9JplpxYoVZAEFo9H4wQcfSITk7gmV6Oho6p1kr1LZ483sRtMfY6xp06bxq90QbaD9uvV7CACgTxjE/rpLcu/nctijXZIQD9vorr9shnU0g9MBWj1oaLe05pq7Yz3zzDPsBssuGxEREaF6yQl2/NGxuKKlZjHc84a/J3rsTn0Jpr6kwqo+2t3wI4LOsdqdnuPxzjbwVH+1TxgoyeG2t8gfG5gEnWPdaaN9Yzns0Afg46Xwvx7Cu223oP/gbicWuvM8HVNU9CARdNsN15poH3/DDQAA469+kfzduzB5Eej/UgjqXmE7gbhd94IzABg0qisO62imzB/uXw2bfYA2NzdX3Rnr6+sLCwvVnVNFfqqjfWNdPA7DHoWnX4fONqg4BxN+A7NTAAD+7Sko/RYAoLEaIobAtJWgCwUACNF3bXE9mw4NN6G1Hua/BwDg6IDr0gdvAPjTpeuNFercZ1EUv/jiC1Wm4gr92zshIWH37t0SIeM+VklJCfVVeUFBAWPLtcmTJ0telbND3cdyfxgO14fcSRb7au7v2NY3Et46C0PG3ye89N+w41kAEQBg1lpYSkkVBxDvu4f/sx0OvS7R6ARN5CdCa6eccxZGo/HatWvukvb2dsbtBq9grCTw4YcfMpYL9RhjTZkyhdUoZnjM2eMSkloozXbnN7d082Lud6w2G2ydBr95Ax55Fvo9BE234cJRyNvW5VUA8M0ucNhh8sKuHzVBgJFTAABy34ERCTByCrQ1wg+fwlf/SppUXKtt7eSVUagWSna/qQRd8A4AB67APLJqa2sDHE2Do54arohQ+DEUftz1L70BPmwGEODW/8GJf+l+uePX/auUsm8IuuAdAA5dcd7u8NFflBPgQCk6VnDQ7nBtL/HRhR+/oS9v9CZV9UEhGB0LAHb+5KgL4V5N3gnw/rlg/LoChTFWU1PT3r17GZXPnz+vqO4bjXXr1sk7Otza6Tqonf2q88gv4blXOOywdyWAAGXfd6O1/6q++La/h+2c8LjdcO7cuR4HV1dXU5sXZGVlPfnkfSVarFYre3YDO06ns8ec987OTr2ekrJiNps/nNUX8ijHw1WhsjVk0iGxvt1VXl4uexJBEEaMGOEu8bTdkJaWJulwabfbqZ0pqFy8eJHlqdDTKR0SXjGs5DyQ1WrltJASxIVbhKpLUHJS9Zk7XMILpzX17Z0AEBkZGeGT1GTJPS8tLVV9CcmhnW4I0hjrHoImRFzzOcTNUndaJ8CKb3VBXtgoqB0LAAS9QUz5EhIWqTVhh0t48RtdtjVIQ6u/ohH9rBOa7xF0oeLvP4OFW0SN0kPxN9tC/vZLbbY1qL+r7qHBUpEAIAgaeOatWytzv6+T6VtOgE+u6h/9HEv7dcEavLe3t2/YsIFR+cyZM2fOnJFrkhew9weksm7dOonkP444nh+rf+MxSIxi/S1zAhy/oX//nKhwZyElJUXJr8fdu3fJy2GHzDkAWkW/rVu33rhxg9S0WCySx3PW7YaWlpbw8HBSMyMjY+3ate6SyspKanYDFavVGh0d3aPaihUrlBxLN5lMkmIHAEDtTGGxWJYvXw4AIdWXdBcOaX/+WnPrkkAcQwWATtCcr9cer4ADpeI1W3ffUjabjeWpcMCAAdRulL0IWbth+fLlrLUblC8vuWuVlZVKhnNCsko3VXq7NCOmwfhpACC2NUH1n6G+AprrwN4Gof0gfOC3l2/+dlVqc0ewR+jdEIzZDV4h9O0Po6fC6KnuQtuN3Gas894twb7dgHACHQvhAjoWwgWlMVZ+fn5+fr7s4ZL3pvc4dOjQgAEDFBilJhcuXEhNTVUyw8KFC9UyxscsW7aMUVNSyQ3YHSssLIx8rV1bW0vNbmCHWjHR5XKRQiqkSdREBpKIiAjqW3ryEIfD4aAaWVRU9Nhjj/W4UGpqKrVgPyNGo/Hnn3+WPZyRw4cPL126lJSzdwAlNb34xlK9ea5yQkJC3PflvNpgVH45vrkhfnjbWcAYC+ECOhbCBcxuQLiA2Q0IFwL7lY7s+myNjY3ULgebNm1izBHgkcJPYrPZyJ2XWbNmHTlyxF1SW1vLnt7uG7g4VlZW1uLFi90l+fn51E/CarXGxsZKhOxfomQ6QFRUVF1dnbyx4M1zJXsmgs1mY+nvOnDgQHJOdiMVZkZcvHhxwoQJPaqtWLFCae0GhbA7h+q/xX744+6HJpGoayQ+FSJcQMdCuICOhXDBixiL/RWeV5DTymjo1f2EgiAERJTDDo/PQt05WR3LU867QqgPyTU1NbL3ERoaGsgXySaT6dSpU/ImFASBujFBbbTB2KiRyqBBg8g0fOoqOTk5siseeoL9mAIV8sIDex/LByQmJkqKNQJAbm7uggULSOXTp0+TvUYZIasQuFwu1R2IE6WlpRJTMcZCuICOhXABHQvhAjoWwgUM3ntAFMWOjg4fLNTe3u6DVXyGNikpiZSSOwuCIFA1qRgMBokkNDSUfTj7oxDjnOTmhUajoY7t16+fRHLu3Dlq2z7qcK1W/h9qTEwM44tk9jtJhVqsgH1O1loHYiDg6bKdTifvpT21bCgqKlJ3oago1mK7SUlJslcpKCigznnx4kWW4cnJydThDodDookxFsIFdCyEC+hYCBfQsRAuaGtra3vbBimqdxpnv0aDwUA+0gYE1GsMCwtj70GnridoH3rooZ61fIuS7AaSzs5O9mu0WCwpKSnukv79+6elUVqCsaSxe8Urr7wiEsnsW7ZsYRlbW1tLvcbMzMxVq1axzMCe3UC9G2SmE26Q9kBcXNzmzZt9sFBGRoZE4nK5GB3Ll6Snp4eFhfWohjEWwgV0LIQL6FgIF9CxEC4EdvB+9erV3jbhF+7cudNNlW8Wxo4dq5Yx/KiqqmJRoztWQkLCq6++qqo9dFavXs2itmTJkueee04izMjIUFKwwGw2T5o0SSJUMmF2drbCThkul0veaaKwsLDMzExSzt6Ynhx++/bt9PR0UlNRkYiEhATZ78/Zod4LAKipqWEZruRIDACYzWZ1L8disSixBwBcLpf7hE4nvZS8b7IbyO0Pr8AYC+ECOhbCBXQshAvoWAgXWLcbRFFU2IIwPj5e0vyOnaKiIt+caGCkqqqKPB7tSwoLC3txdRZYHau1tXXGjBlKViooKJg+fbq8sZs3b6bm8Ofl5bEMV72sY3FxMfWIPWlPbm4utYEA1XLGvYacnBwl3Rt9Q2BvkM6ZM6fH0jSdnb7rpRsXFyep3ZCbm0vVnDVrVoB2BmAEYyyEC+hYCBfQsRAuoGMhXAjs4P2zzz4jhUuWLGEcnp2dzaI2efLkcePGeWEWA4cPHyaF7Jb7P/Tn24SEhHPnzrlLlJeKJLcb9uzZQ81uIA9TLFy4kPEBOyoqqr6+XiIsKSkhNdmPDxw7dmz+/Pnukvr6emr2yPjx4yXlG65evdrW1iZRS0lJ8dSo0X3HwauKfmlpaS+88IJESL3GvLy8oUOHSoSxsbGhoaHuksrKSiVZQIH9jcUImT2iMHFqwIABjD1gx4wZo2Qhr5BcZmlpKaMmleHDhw8fPly2MRhjIVxAx0K4gI6FcAEdC+FCUATvCikpKaE+V6qOwnPP6p7YPnr06OXLlxmV09LSJG/Qg9SxIiIiyP0Cu90+atQoUpl6poAH5EJGo5HMVoqJiSHHqn4Y//Lly+wX/uabb0p2RoLUsQCA3MupqKjoFUu6R2JnoNTAxRgL4QI6FsIFjcjcBRlB2NE8YI38ED8hSIP35ubmtWvX9rYV/sLJkycPHjyoZIaXX35ZImF1rLCwsObmZiVr86jtKdskp9O5f/9+RuVjx47NmTPHXfL1119TD1NQsdlsLB0rhg8fztKZIjQ0VOEHQVYlbWpqYr8b5OozZ84kh3vxjcVSINDH9O3bV2GfX0YUXru6t67XPwgsFYn0GuhYCBfQsRAuoGMhXPAYvCcmJvrSDnlQOwmSjBgx4ujRo7JX2bRp06ZNm2QPnz17tuyxoOyDWL9+vaQR3NmzZ81msxJ7Ahiyop/C1o8mk0kyoc1mo2paLBbH/XjqV0ilvLxcMtyrT9FBwD6WSmZmJmNFP3aam5slc5JmOxyOIN0g7Qb2gzGqD9doNJJTOkos8RnUS8YYC+ECOhbCBXQshAvoWAgX/h+GEUFXj37f5gAAAABJRU5ErkJggg=="
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}
{
    "success": false,
    "data": [
        "error"
    ],
    "message": "Ocurrió un error generando el recurso"
}

Onboarding

Register

POST
https://app.bepay.com.co
/api/v1/Onboarding/signup
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
multipart/form-data
Accept
Example:
application/json

Body Parameters

Payout

Transfiya


Transfiya Onboarding

POST
https://app.bepay.com.co
/api/v1/payout/transfiya/onboarding
requires authentication

Inicia proceso de onboarding en Transfiya para uno o varios números de teléfono

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "message": "",
    "data": [
        {
            "phone": "3001234567",
            "status": "Onboarding iniciado"
        },
        {
            "phone": "3007654321",
            "status": "Onboarding iniciado"
        }
    ]
}

Obtener Signers Transfiya

POST
https://app.bepay.com.co
/api/v1/payout/transfiya/signers
requires authentication

Obtiene los signers de Transfiya para un número de teléfono y cuenta
(Si estas en ambiente de pruebas y el número de teléfono termina en número par la dispersión será APROBADA de lo contrario será RECHAZADA)

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
  "success": true,
  "message": "",
  "data": [
    {
      "phone": "3001234567",
      "signers": [
        {
          "handle": "34ufyIJHuE54fdhahx",
          "bankName": "NEQUI",
          "bankCode": "BC004",
          "bankAccountNumber": "xxxxxxx6552",
        }
      ]
    },
    {
      "phone": "3007654321",
      "signers": [
        {
          "handle": "09ufyIJHuE54X8ahx",
          "bankName": "Bancolombia",
          "bankCode": "BC001",
          "bankAccountNumber": "xxxxxxx3454",
        }
      ]
    }
  ]
}

Dispersiones transfiya

POST
https://app.bepay.com.co
/api/v1/payout/transfiya/send
requires authentication

Este endpoint envía dinero a uno o varios signers de Transfiya.
(Si estas en ambiente de pruebas y el número de teléfono termina en número par la dispersión será APROBADA de lo contrario será RECHAZADA)

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "message": "",
    "data": {
        "id": 171,
        "total_amount": 150000,
        "status": "STARTED",
        "description": "PAGO DE SERVICIOS",
        "processed_at": null,
        "payouts": [
            {
                "id": "12345",
                "transfiya_handle": "34fyIJHuE54X8fgdhx",
                "phone_number": "3024567586",
                "total_amount": "150000.00",
                "fixed_comission": "700.00",
                "percent_comission": "0.00",
                "status": "PENDING",
                "bank_status": null,
                "bank_status_description": null,
                "processed_at": null
            }
        ]
    }
}

Bre-b

Permite registrarse en Bre-b y generar un QR estático asociado al comercio


Dispersiones Bre-b

POST
https://app.bepay.com.co
/api/v1/payout/breb/send
requires authentication

Este endpoint envía dinero a uno o varios signers de Bre-b.
(Si estas en ambiente de pruebas y la llave de envío termina en número par la dispersión será APROBADA de lo contrario será RECHAZADA)

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "message": "",
    "data": {
        "id": 171,
        "total_amount": 150000,
        "status": "STARTED",
        "description": "PAGO DE SERVICIOS",
        "processed_at": null,
        "payouts": [
            {
                "id": "12345",
                "key_number": "@BE12345678",
                "total_amount": "150000.00",
                "fixed_comission": "700.00",
                "percent_comission": "0.00",
                "status": "PENDING",
                "bank_status": null,
                "bank_status_description": null,
                "processed_at": null
            }
        ]
    }
}

Consultar llave Bre-b

GET
https://app.bepay.com.co
/api/v1/payout/get/{key}
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

key
string
required
Example:
blanditiis
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "success": false,
    "data": null,
    "meta": [],
    "message": "Unauthenticated."
}

ACH


Obtener códigos de bancos

GET
https://app.bepay.com.co
/api/v1/payout/bankCodes
requires authentication

Este endpoint consulta los códigos de bancos disponibles.

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
{
    "success": true,
    "message": "",
    "data": {
        "001": "BANCO DE BOGOTA",
        "002": "BANCO POPULAR",
        "006": "ITAU",
        "007": "BANCOLOMBIA",
        "009": "CITIBANK COLOMBIA",
        "012": "BANCO GNB SUDAMERIS",
        "013": "BANCO BBVA",
        "014": "ITAU CORPBANCA COLOMBIA S.A",
        "019": "BANCO SCOTIABANK COLPATRIA",
        "023": "BANCO DE OCCIDENTE",
        "031": "BANCOLDEX S.A.",
        "032": "BANCO CAJA SOCIAL",
        "036": "MEGABANCO",
        "040": "BANAGRARIO"
    }
}

Dispersiones ACH

POST
https://app.bepay.com.co
/api/v1/payout/ach/send
requires authentication

Este endpoint envía dinero a una o varias cuentas bancarias a traves de ACH.
(Si estas en ambiente de pruebas y el número de la cuenta termina en número par la dispersión será APROBADA de lo contrario será RECHAZADA)

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "message": "",
    "data": {
        "id": 172,
        "total_amount": 62217.2,
        "status": "STARTED",
        "description": "Blanditiis est sequi tenetur sit molestiae.",
        "payouts": [
            {
                "id": "12345",
                "id_type": "C",
                "id_number": 108864536,
                "beneficiary_name": "PRUEBA",
                "account_type": "2",
                "account_number": "115434556",
                "total_amount": "62217.20",
                "fixed_comission": "800.00",
                "percent_comission": "1555.43",
                "bank_code": "001",
                "status": "PENDING",
                "bank_status": null,
                "bank_status_description": null,
                "processed_at": null
            }
        ]
    }
}

Consultar estado de dispersión

GET
https://app.bepay.com.co
/api/v1/payout/status/{id}/{account_id}
requires authentication

Este endpoint consulta el estado de una dispersión.

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

id
integer
required

Id de la dispersión a consultar. Ejemplo: 1

Example:
8
account_id
integer
required

Id de la cuenta a consultar. Ejemplo: 3

Example:
1
Example response:

Transacciones

Crear una transacción

POST
https://app.bepay.com.co
/api/v1/checkout/transactions
requires authentication

Este endpoint genera una nueva transacción

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjYxZDUzYWZjYWQyYjguNzE5NzgxNzQ",
        "total": "10000.00",
        "link": "https://<<baseUrl>>/NjYxZDUzYWZjYWQyYjguNzE5NzgxNzQ",
        "qr": null
    },
    "meta": [],
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Procesar pago PSE

POST
https://app.bepay.com.co
/api/v1/checkout/checkoutPse
requires authentication

Este endpoint retorna un link para inicializar un pago através de PSE

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5YzYwZDAwOWFmMA",
        "pseReturnCode": "SUCCESS",
        "link": "https://registro.desarrollo.pse.com.co/PSENF/index.html?enc=847TD1HPg%2boElpGkHFzoBnI8rh2ya8TQgJktzZlvS04%3d",
        "trazabilityCode": "3012132"
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Procesar pago tarjeta

POST
https://app.bepay.com.co
/api/v1/checkout/checkoutCard
requires authentication

Este endpoint permite procesar un pago por medio de tarjeta

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "status": "APPROVED",
        "paymentmethod": "TC",
        "transaction_ide": "NjYxZDUzYWZjYWQyYjguNzE5NzgxNzQ",
        "transacton_ide": "NjYxZDUzYWZjYWQyYjguNzE5NzgxNzQ",
        "transaction_id": 79,
        "transacton_id": 79,
        "transaction_total": "100.00",
        "transacton_total": "100.00",
        "transaction_tax": "0.00",
        "transaction_description": "Pago de preuba API",
        "transaction_extra1": null,
        "transaction_extra2": null,
        "transaction_extra3": null,
        "transaction_extra4": null,
        "transaction_extra5": null,
        "traceability_code": "16966491",
        "started_at": "2024-04-12 00:43:02",
        "processed_at": "2024-04-12 00:43:02",
        "payer_name": "Juan Perez",
        "payer_document": "2222222222",
        "payer_address": "Cll 55 44 33",
        "payer_phone": "3215700000",
        "payer_email": "fake@bemovil.net",
        "payer_ip": "127.0.0.1",
        "account_id": 1,
        "financial_entity": "N/A",
        "details": {}
    },
    "meta": [],
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Procesar pago NEQUI PUSH

POST
https://app.bepay.com.co
/api/v1/checkout/checkoutNequiPush
requires authentication

Este endpoint genera una solicitud de cobro al cliente en su aplicación Nequi

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5YzYwZDAwOWFmMA",
        "link": "https://{domain}/resume/NjM5YzYwZDAwOWFmMA",
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Estado de transacción

GET
https://app.bepay.com.co
/api/v1/checkout/transactionStatus
requires authentication

Este endpoint devuelve el estado de una transacción

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Query Parameters

Token
string
required

Id de la transacción devuelto por el método Crear una transacción en el campo ide

Example:
NjM5Nzc1YzAyOTY5ZA
account_id
integer
required

Id de la cuenta con la que se generará el link Debe ser un valor devuelto por el endpoint Obtener listado de cuentas

Example:
2
Example response:
{
    "success": true,
    "data": {
        "status": "APPROVED",
        "paymentmethod": "BANCOLOMBIA_QR",
        "transaction_ide": "edeb8e22-9d2d-4c96-bcd7-cc92c1c60458",
        "transacton_ide": "edeb8e22-9d2d-4c96-bcd7-cc92c1c60458",
        "transaction_id": 79,
        "transacton_id": 79,
        "transaction_total": "100.00",
        "transacton_total": "100.00",
        "transaction_tax": "0.00",
        "transaction_description": "Pago Qr Bancolombia multi-uso",
        "transaction_extra1": null,
        "transaction_extra2": null,
        "transaction_extra3": null,
        "transaction_extra4": null,
        "transaction_extra5": null,
        "traceability_code": "16966491",
        "started_at": "2024-04-12 00:43:02",
        "processed_at": "2024-04-12 00:43:02",
        "payer_name": "Juan Perez",
        "payer_document": "2222222222",
        "payer_address": "Cll 55 44 33",
        "payer_phone": "3215700000",
        "payer_email": "fake@bemovil.net",
        "payer_ip": "127.0.0.1",
        "account_id": 1,
        "financial_entity": "BANCOLOMBIA_QR",
        "details": {}
    },
    "meta": [],
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

getTransactionsBy

GET
https://app.bepay.com.co
/api/v1/transactions/getTransactionsBy/{account_id}/{by}/{value}
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

account_id
integer
required

Id de la cuenta a la que pertence la transacción.

Example:
1
by
string
required

Variable por la que se desea ubicar la transacción
extra_1|extra_2|extra_3|extra_4|transaction_date.

Example:
extra_1
value
string
required

Valor que se desea usar para encontrar una transacción .

Example:
invoice-001

Query Parameters

per_page
number

Número de registros por página,
por defecto: 15.

Example:
10
page
number

Página de resultados.

Example:
1
Example response:

disablePendingTransaction

PUT
https://app.bepay.com.co
/api/v1/transactions/disablePendingTransaction/{account_id}/{transaction_ide}
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

account_id
integer
required

Id de la cuenta a la que pertence la transacción.

Example:
1
transaction_ide
string
required

Token de la transacción.

Example:
NjQ3N2UzMmRlOWE5YQ

Botón Bancolombia

Procesar pagos usando botón Bancolombia


Procesar pago Botón Bancolombia

POST
https://app.bepay.com.co
/api/v1/checkout/checkoutBancolombiaButton
requires authentication

Este endpoint retorna un link para inicializar un pago através de Botón Bancolombia

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5YzYwZDAwOWFmMA",
        "pseReturnCode": "SUCCESS",
        "link": "https://registro.desarrollo.pse.com.co/PSENF/index.html?enc=847TD1HPg%2boElpGkHFzoBnI8rh2ya8TQgJktzZlvS04%3d",
        "trazabilityCode": "3012132"
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Transfiya

Obtener listado de signers asociados a un número celular para generar la solicitud de pago

Obtener signers


Obtener signers

GET
https://app.bepay.com.co
/api/v1/checkout/transfiya/get-signers/{phone}/{account_id}
requires authentication

Este endpoint devuelve los signers asociados a un número celular

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

phone
integer
required

número celular vinculado a Transfiya

Example:
3215704751
account_id
integer
required

Id de su cuenta Bepay

Example:
1
Example response:

Procesar pago Transfiya

POST
https://app.bepay.com.co
/api/v1/checkout/checkout-transfiya
requires authentication

Este endpoint permite realizar un pago usando Transfiya

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5YzYwZDAwOWFmMA",
        "link": "https://{domain}/resume/NjM5YzYwZDAwOWFmMA",
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Bre-b

Permite registrarse en Bre-b y generar un QR estático asociado al comercio


Registro Bre-b

POST
https://app.bepay.com.co
/api/v1/bre-b/register
requires authentication

Este endpoint permite registrarse en el ecosistema Bre-b y generar un QR estático asociado al comercio

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

QR estático Bre-b

POST
https://app.bepay.com.co
/api/v1/bre-b/static-qr
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Qr Dinámico Bre-b

POST
https://app.bepay.com.co
/api/v1/bre-b/dynamic-qr
requires authentication

Este endpoint permite realizar un pago usando un QR compatible con múltiples entidades financieras, cada solicitud genera nuevo QR el cual solo puede ser usado una única vez

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Example response:
{
    "success": true,
    "data": {
        "ide": "NjM5YzYwZDAwOWFmMA",
        "link": "https://{domain}/resume/NjM5YzYwZDAwOWFmMA",
        "qr": "iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQCAYAAACAvzbM..."
    },
    "message": ""
}
{
    "success": false,
    "data": null,
    "message": "No se ha especificado un id de cuenta válido"
}
{
    "message": "Unauthenticated."
}
{
    "success": false,
    "data": "1",
    "message": "El usuario que está autenticado no tiene acceso a la cuenta seleccionada"
}

Crear llave Bre-b

POST
https://app.bepay.com.co
/api/v1/bre-b/key/register
requires authentication

Este endpoint permite generar llaves Bre-b para un comercio o subcuenta

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Mis llaves Bre-b

POST
https://app.bepay.com.co
/api/v1/bre-b/key/get
requires authentication

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json

Body Parameters

Efecty

Validar si el reference existe


Validar referencia

GET
https://app.bepay.com.co
/api/v1/efecty/validate-reference/{reference}

Este endpoint valida que la referencia exista

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

reference
integer
required

Transaction ID

Example:
1234567890
Example response:
Headers 
                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 500
                                                                                                                    x-ratelimit-remaining
                                                            : 499
                                                                                                                    access-control-allow-origin
                                                            : *
                                                         
{
    "success": false,
    "data": null,
    "meta": [],
    "message": {
        "reference": [
            "La referencia no existe."
        ]
    }
}

Widgets

Webcheckout Widget

GET
https://app.bepay.com.co
/api/v1/webcheckout
requires authentication

Esta documentación explica como integrar de manera simple nuestro plugin de webcheckout. Esta es la forma más rápida y sencilla de comenzar a procesar pagos sin necesidad de escribir mucho código.

Headers

Authorization
Example:
Bearer {PERSONAL_ACCESS_TOKEN}
Content-Type
Example:
application/json
Accept
Example:
application/json
Example response:
Headers 
                                                            content-type
                                                            : text/html; charset=UTF-8
                                                                                                                    cache-control
                                                            : no-cache, private
                                                                                                                    x-ratelimit-limit
                                                            : 500
                                                                                                                    x-ratelimit-remaining
                                                            : 499
                                                                                                                    access-control-allow-origin
                                                            : *