API - DOCUMENTACIÓN

Postman collection → OpenAPI spec →

Introduction

Utiliza nuetra API para procesar pagos de forma segura

Base URL: https://production.b2pagos.com

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://production.b2pagos.com

/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

Example:

application/json

Body Parameters

string

required

Correo electrónico de un usuario con cuenta activa en ELP-LATAM

Example:

efren.pfannerstill@hotmail.com

password

string

required

Contraseña de un usuario con cuenta activa en ELP-LATAM

Example:

test

Headers

Body

{ "email": "efren.pfannerstill@hotmail.com", "password": "test" }

Received response

Example response:

{
    "success": true,
    "data": "43|Twf760yNIOzPwU5TOsxqHg8dV6XsaOMkkRaeea8f",
    "message": ""
}

Obtener listado de cuentas

GET

https://production.b2pagos.com

/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

Example:

application/json

Auth

Bearer

Headers

Received response

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": ""
}

Obtener metodos de pago de una cuenta

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

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:

Auth

Bearer

Headers

Body

{ "account_id": 3 }

Received response

Example response:

{
    "success": true,
    "data": [
        "TC",
        "PSE",
        "WALLETVISA"
    ],
    "message": ""
}

Obtener monedas disponibles

GET

https://production.b2pagos.com

/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

Example:

application/json

Auth

Bearer

Headers

Received response

Example response:

{
    "success": true,
    "data": [
        {
            "iso_code": "COP",
            "symbol": "$",
            "decimal_separator": ",",
            "thousand_separator": "."
        }
    ],
    "message": ""
}

Obtener los impuestos disponibles

GET

https://production.b2pagos.com

/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

Example:

application/json

Auth

Bearer

Headers

Received response

Example response:

{
    "success": true,
    "data": [
        {
            "type": "IVA",
            "value": "0.00"
        },
        {
            "type": "IVA",
            "value": "5.00"
        },
        {
            "type": "IVA",
            "value": "19.00"
        }
    ],
    "message": ""
}

Obtener paises

GET

https://production.b2pagos.com

/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

Example:

application/json

Auth

Bearer

Headers

Received response

Example response:

{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Colombia",
            "code_country": 57
        }
    ],
    "message": ""
}

Obtener regiones

GET

https://production.b2pagos.com

/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

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:

Auth

Bearer

Headers

URL Parameters

Received response

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": ""
}

Obtener ciudades

GET

https://production.b2pagos.com

/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

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:

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

Auth

Bearer

Headers

URL Parameters

Received response

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": ""
}

Obtener tipos de documentos

GET

https://production.b2pagos.com

/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

Example:

application/json

Auth

Bearer

Headers

Received response

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": ""
}

Obtener bancos PSE

GET

https://production.b2pagos.com

/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

Example:

application/json

Auth

Bearer

Headers

Received response

Example response:

{
    "success": true,
    "data": [
        {
            "name": "BANCO PSE",
            "code": "1101"
        },
        {
            "name": "BANCO UNION COLOMBIANO",
            "code": "1022"
        }
    ],
    "message": ""
}

Bancos

GET

https://production.b2pagos.com

/api/v1/Banks

requires authentication

Headers

Authorization

Example:

Bearer {PERSONAL_ACCESS_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

per_page

integer

records per page

Example:

Auth

Bearer

Headers

Query Parameters

Received response

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://production.b2pagos.com

/api/v1/ciiuCodes

requires authentication

Headers

Authorization

Example:

Bearer {PERSONAL_ACCESS_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

per_page

integer

records per page

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "success": false,
    "data": null,
    "meta": [],
    "message": "Unauthenticated."
}

Cobros

Generar un link de cobro

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

type

string

required

Este parámetro siempre debe ser link

Example:

link

reference

string

required

Example:

REF001

currency_code

string

required

Código ISO de la moneda que se usará para generar el link de pago ver método /currency

Example:

COP

tax_percentage

decimal

required

Porcentaje de impuestos con el que se calcularán los impuestos de la transacción

Example:

19.00

tax_value

decimal

required

Valor calculado de los impuestos de la transacción

Example:

190

tax_base

decimal

required

Valor calculado de la base sobre la que se aplica el impuesto

Example:

840.34

total

decimal

required

Valor total por el que se generará el link de cobro

Example:

1000

description

string

required

Descripción textual para identificar el cobro

Example:

Compra ecommerce #645213

redirect_url

string

Url donde será redireccionado el usuario al finalizar la transacción

Example:

https://elplatam.com

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:

extra2

string

extra 2

Example:

REF741852

extra3

string

extra 3

Example:

REF875485

Auth

Bearer

Headers

Body

{ "type": "link", "reference": "REF001", "currency_code": "COP", "tax_percentage": "19.00", "tax_value": "190", "tax_base": "840.34", "total": "1000", "description": "Compra ecommerce #645213", "redirect_url": "https:\/\/elplatam.com", "account_id": 2, "extra2": "REF741852", "extra3": "REF875485" }

Received response

Example response:

{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}

Envia un SMS de cobro

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

type

string

required

Este parámetro siempre debe ser sms

Example:

sms

reference

string

required

Example:

REF001

currency_code

string

required

Código ISO de la moneda que se usará para generar el link de pago ver método /currency

Example:

COP

tax_percentage

decimal

required

Porcentaje de impuestos con el que se calcularán los impuestos de la transacción

Example:

19.00

tax_value

decimal

required

Valor calculado de los impuestos de la transacción

Example:

190

tax_base

decimal

required

Valor calculado de la base sobre la que se aplica el impuesto

Example:

840.34

total

decimal

required

Valor total por el que se generará el link de cobro

Example:

1000

description

string

required

Descripción textual para identificar el cobro

Example:

Compra ecommerce #645213

redirect_url

string

Url donde será redireccionado el usuario al finalizar la transacción

Example:

https://elplatam.com

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:

payer_country_code

integer

required

código del pais code_country, devuelto por el endpoint api/v1/country

Example:

payer_language

string

required

Idioma en el que se enviará el SMS,
los valores soportados: es|en|fr|pr|it

Example:

payer_mobile_number

number

required

Número móvil al que se enviará el SMS

Example:

3215704751

extra2

string

extra 2

Example:

REF741852

extra3

string

extra 3

Example:

REF875485

Auth

Bearer

Headers

Body

{ "type": "sms", "reference": "REF001", "currency_code": "COP", "tax_percentage": "19.00", "tax_value": "190", "tax_base": "840.34", "total": "1000", "description": "Compra ecommerce #645213", "redirect_url": "https:\/\/elplatam.com", "account_id": 2, "payer_country_code": 57, "payer_language": "es", "payer_mobile_number": 3215704751, "extra2": "REF741852", "extra3": "REF875485" }

Received response

Example response:

{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}

Envia un Whatsapp de cobro

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

type

string

required

Este parámetro siempre debe ser whatsapp

Example:

reference

string

required

Example:

REF001

currency_code

string

required

Código ISO de la moneda que se usará para generar el link de pago ver método /currency

Example:

COP

tax_percentage

decimal

required

Porcentaje de impuestos con el que se calcularán los impuestos de la transacción

Example:

19.00

tax_value

decimal

required

Valor calculado de los impuestos de la transacción

Example:

190

tax_base

decimal

required

Valor calculado de la base sobre la que se aplica el impuesto

Example:

840.34

total

decimal

required

Valor total por el que se generará el link de cobro

Example:

1000

description

string

required

Descripción textual para identificar el cobro

Example:

Compra ecommerce #645213

redirect_url

string

Url donde será redireccionado el usuario al finalizar la transacción

Example:

https://elplatam.com

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:

payer_country_code

integer

required

código del pais code_country, devuelto por el endpoint api/v1/country

Example:

payer_language

string

required

Idioma en el que se enviará el SMS,
los valores soportados: es|en|fr|pr|it

Example:

payer_mobile_number

number

required

Número móvil al que se enviará el SMS

Example:

3215704751

extra2

string

extra 2

Example:

REF741852

extra3

string

extra 3

Example:

REF875485

Auth

Bearer

Headers

Body

{ "type": "whatsapp", "reference": "REF001", "currency_code": "COP", "tax_percentage": "19.00", "tax_value": "190", "tax_base": "840.34", "total": "1000", "description": "Compra ecommerce #645213", "redirect_url": "https:\/\/elplatam.com", "account_id": 2, "payer_country_code": 57, "payer_language": "es", "payer_mobile_number": 3215704751, "extra2": "REF741852", "extra3": "REF875485" }

Received response

Example response:

{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}

Envia un email de cobro

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

type

string

required

Este parámetro siempre debe ser email

Example:

reference

string

required

Example:

REF001

currency_code

string

required

Código ISO de la moneda que se usará para generar el link de pago ver método /currency

Example:

COP

tax_percentage

decimal

required

Porcentaje de impuestos con el que se calcularán los impuestos de la transacción

Example:

19.00

tax_value

decimal

required

Valor calculado de los impuestos de la transacción

Example:

190

tax_base

decimal

required

Valor calculado de la base sobre la que se aplica el impuesto

Example:

840.34

total

decimal

required

Valor total por el que se generará el link de cobro

Example:

1000

description

string

required

Descripción textual para identificar el cobro

Example:

Compra ecommerce #645213

redirect_url

string

Url donde será redireccionado el usuario al finalizar la transacción

Example:

https://elplatam.com

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:

payer_email

string

required

Correo electrónico donde se enviará el link de pago

Example:

bmaya@elplatam.com

extra2

string

extra 2

Example:

REF741852

extra3

string

extra 3

Example:

REF875485

Auth

Bearer

Headers

Body

{ "type": "email", "reference": "REF001", "currency_code": "COP", "tax_percentage": "19.00", "tax_value": "190", "tax_base": "840.34", "total": "1000", "description": "Compra ecommerce #645213", "redirect_url": "https:\/\/elplatam.com", "account_id": 2, "payer_email": "bmaya@elplatam.com", "extra2": "REF741852", "extra3": "REF875485" }

Received response

Example response:

{
    "success": true,
    "data": {
        "ide": "NjM5N2QyZTkyZmY3Ng",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5N2QyZTkyZmY3Ng",
        "qr": null
    },
    "message": ""
}

Generar un QR de cobro

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

type

string

required

Este parámetro siempre debe ser qr

Example:

reference

string

required

Example:

REF001

currency_code

string

required

Código ISO de la moneda que se usará para generar el link de pago ver método /currency

Example:

COP

tax_percentage

decimal

required

Porcentaje de impuestos con el que se calcularán los impuestos de la transacción

Example:

19.00

tax_value

decimal

required

Valor calculado de los impuestos de la transacción

Example:

190

tax_base

decimal

required

Valor calculado de la base sobre la que se aplica el impuesto

Example:

840.34

total

decimal

required

Valor total por el que se generará el link de cobro

Example:

1000

description

string

required

Descripción textual para identificar el cobro

Example:

Compra ecommerce #645213

redirect_url

string

Url donde será redireccionado el usuario al finalizar la transacción

Example:

https://elplatam.com

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:

extra2

string

extra 2

Example:

REF741852

extra3

string

extra 3

Example:

REF875485

Auth

Bearer

Headers

Body

{ "type": "qr", "reference": "REF001", "currency_code": "COP", "tax_percentage": "19.00", "tax_value": "190", "tax_base": "840.34", "total": "1000", "description": "Compra ecommerce #645213", "redirect_url": "https:\/\/elplatam.com", "account_id": 2, "extra2": "REF741852", "extra3": "REF875485" }

Received response

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": ""
}

Checkout

Crear una transacción

POST

https://production.b2pagos.com

/api/v1/checkout/transactions

requires authentication

Este endpoint permite crear una transacción para su posterior procesamiento

Headers

Authorization

Example:

Bearer {PERSONAL_ACCESS_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Este parámetro siempre debe ser link

Example:

link

reference

string

required

Example:

REF001

currency_code

string

required

Código ISO de la moneda que se usará para generar el link de pago ver método /currency

Example:

COP

tax_percentage

decimal

required

Porcentaje de impuestos con el que se calcularán los impuestos de la transacción

Example:

19.00

tax_value

decimal

required

Valor calculado de los impuestos de la transacción

Example:

190

tax_base

decimal

required

Valor calculado de la base sobre la que se aplica el impuesto

Example:

840.34

total

decimal

required

Valor total por el que se generará el link de cobro

Example:

1000

description

string

required

Descripción textual para identificar el cobro

Example:

Compra ecommerce #645213

redirect_url

string

Must be a valid URL.

Example:

http://www.harber.com/commodi-omnis-ut-est-rerum-autem-vero-sed-laudantium

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:

extra2

string

Descripción complementaria sobre la transacción

Example:

Pago a través del ELP-API

extra3

string

Descripción complementaria sobre la transacción

Example:

Pago a través del ELP-API

Auth

Bearer

Headers

Body

{ "type": "link", "reference": "REF001", "currency_code": "COP", "tax_percentage": "19.00", "tax_value": "190", "tax_base": "840.34", "total": "1000", "description": "Compra ecommerce #645213", "redirect_url": "http:\/\/www.harber.com\/commodi-omnis-ut-est-rerum-autem-vero-sed-laudantium", "account_id": 2, "extra2": "Pago a trav\u00e9s del ELP-API", "extra3": "Pago a trav\u00e9s del ELP-API" }

Received response

Example response:

{
    "success": true,
    "data": {
        "ide": "NjM5YzYxM2JjNTBmYg",
        "total": "1000.00",
        "link": "https://<<baseUrl>>/NjM5YzYxM2JjNTBmYg",
        "qr": null
    },
    "message": ""
}

Procesar pago PSE

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

direccion

string

required

Dirección del usuario que pagará la transacción

Example:

P. Sherman 42 Wallaby Way Sydney

apellidos

string

required

Apellidos del usuario que pagará la transacción

Example:

Maya Galeano

ciudad

integer

required

Ciudad del usuario que pagará la transacción

Example:

company_terms

string

required

Aceptación de términos y condiciones

Example:

pais

integer

required

Pais del usuario que pagará la transacción

Example:

string

required

Correo electrónico del usuario que pagará la transacción

Example:

david@mayagaleano.com

nombres

string

required

Nombres del usuario que pagará la transacción

Example:

Juan David

numero_documento

string

required

Example:

1036636123

telefono

string

required

Teléfono del usuario que pagará la transacción

Example:

3215704751

tipo_documento

integer

required

Tipo de documento del usuario que pagará la transacción

Example:

transaction_id

string

required

The ide of an existing record in the transactions table.

Example:

similique

transaction_ip

string

required

value debe ser una dirección IP válida.

Example:

177.129.235.179

codigo_postal

string

required

Código postal del usuario que pagará la transacción

Example:

055422

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:

metodopago

string

required

Método de pago con el que se procesará la transacción

Example:

PSE

typeuser

string

required

Tipo de usuario que realizará el pago: person|company

Example:

person

bank

integer

required

Banco con el que se realizará el pago: id devuelto del método Obtener bancos PSE

Example:

1022

redirect_url

string

required

Url de redirección una vez procesada la transacción, Nota: Luego consimir método Estado de transacción para obtener el resultado de la misma

Example:

https://example.com/resume

Auth

Bearer

Headers

Body

{ "direccion": "P. Sherman 42 Wallaby Way Sydney", "apellidos": "Maya Galeano", "ciudad": 1, "company_terms": "Y", "pais": 1, "email": "david@mayagaleano.com", "nombres": "Juan David", "numero_documento": "1036636123", "telefono": "3215704751", "tipo_documento": 1, "transaction_id": "similique", "transaction_ip": "177.129.235.179", "codigo_postal": "055422", "Token": "NjM5Nzc1YzAyOTY5ZA", "account_id": 2, "metodopago": "PSE", "typeuser": "person", "bank": 1022, "redirect_url": "https:\/\/example.com\/resume" }

Received response

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": ""
}

Procesar pago tarjeta

POST

https://production.b2pagos.com

/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

Example:

application/json

Body Parameters

direccion

string

required

Dirección del usuario que pagará la transacción

Example:

P. Sherman 42 Wallaby Way Sydney

apellidos

string

required

Apellidos del usuario que pagará la transacción

Example:

Maya Galeano

ciudad

integer

required

Ciudad del usuario que pagará la transacción

Example:

company_terms

string

required

Aceptación de términos y condiciones

Example:

pais

integer

required

Pais del usuario que pagará la transacción

Example:

string

required

Correo electrónico del usuario que pagará la transacción

Example:

david@mayagaleano.com

nombres

string

required

Nombres del usuario que pagará la transacción

Example:

Juan David

numero_documento

string

required

Example:

1036636123

telefono

string

required

Teléfono del usuario que pagará la transacción

Example:

3215704751

tipo_documento

integer

required

Tipo de documento del usuario que pagará la transacción

Example:

transaction_id

string

required

The ide of an existing record in the transactions table.

Example:

transaction_ip

string

required

value debe ser una dirección IP válida.

Example:

17.243.15.108

codigo_postal

string

required

Código postal del usuario que pagará la transacción

Example:

055422

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:

metodopago

string

required

Método de pago con el que se procesará la transacción

Example:

creditcard_name

string

required

Nombre del titular de la tarjeta (tarjetahabiente)

Example:

David Maya

creditcard_number

string

required

Número de la tarjeta
Ejemplo antes de encriptar: 4564 0000 0000 0001
Ejemplo encriptado:

creditcard_expirationdate

string

required

Fecha de expiración de la tarjeta
Ejemplo antes de encriptar: 05/28
Ejemplo encriptado:

creditcard_securitycode

string

required

CVV de la tarjeta
Ejemplo antes de encriptar: 123
Ejemplo encriptado:

tipo_tc

string

required

Example:

VISA

Auth

Bearer

Headers

Body

{ "direccion": "P. Sherman 42 Wallaby Way Sydney", "apellidos": "Maya Galeano", "ciudad": 1, "company_terms": "Y", "pais": 1, "email": "david@mayagaleano.com", "nombres": "Juan David", "numero_documento": "1036636123", "telefono": "3215704751", "tipo_documento": 1, "transaction_id": "at", "transaction_ip": "17.243.15.108", "codigo_postal": "055422", "Token": "NjM5Nzc1YzAyOTY5ZA", "account_id": 2, "metodopago": "TC", "creditcard_name": "David Maya", "creditcard_number": "", "creditcard_expirationdate": "", "creditcard_securitycode": "", "tipo_tc": "VISA" }

Received response

Example response:

{
    "success": true,
    "data": {
        "status": "APPROVED|REJECTED",
        "details": {
            "success": true,
            "subject": "Método AutorizarNormal consumido exitosamente",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJjMjA1YTJmYy0yNjNkLTRiMmEtYTUzOS04ZjczYzViNzdmYzEiLCJpYXQiOjE2NjgyODU1NjUsImlzcyI6IjVjNGI0ZGI0MGU0MjNkMTQ3MGJjOGM2MyIsIk9yZ1VuaXRJZCI6IjVjNDg5ZGM1MGU0MjNkMTIxODk5Zjc3ZCIsIlBheWxvYWQiOnsiT3JkZXJEZXRhaWxzIjp7Ik9yZGVyTnVtYmVyIjoiMmY5ODFiNzQtZmFiNS00OWNjLTgzMTAtZTM0NmE0MTAxMDczIn19LCJPYmplY3RpZnlQYXlsb2FkIjoidHJ1ZSIsIlJlZmVyZW5jZUlkIjoiMmY5ODFiNzQtZmFiNS00OWNjLTgzMTAtZTM0NmE0MTAxMDczIiwiZXhwIjoxNjk5ODIxNTY1fQ.ZKsmEFwESeNoFop9lgQvbjEinvx4UXS7xuvhimyi0N0",
            "output": "00",
            "details": "{\"stateCode\":\"00\",\"authorizationCode\":\"748492\",\"authorizedAmount\":1000,\"transactionId\":\"92112567523\"}"
        }
    },
    "message": ""
}

Estado de transacción

GET

https://production.b2pagos.com

/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

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:

Auth

Bearer

Headers

Query Parameters

Received response

Example response:

{
    "success": true,
    "data": {
        "status": "APPROVED",
        "details": {
            "entityCode": "10171290997",
            "errorDetails": null,
            "trazabilityCode": "3012132",
            "ticketId": 277,
            "financialInstitutionCode": "1022",
            "serviceCode": "1001",
            "transactionValue": 1000,
            "vatValue": 190,
            "soliciteDate": "2022-12-16T00:00:00",
            "bankProcessDate": "2022-12-16T07:13:29.803",
            "transactionCycle": 1,
            "transactionState": "OK",
            "authorizationID": "9f41e2f0-bc82-4ab1-8",
            "serviceNIT": "10171290997",
            "serviceName": "Recaudo",
            "userType": "person",
            "paymentDescription": "Compra ecommerce #645213",
            "referenceNumber1": "",
            "referenceNumber2": "",
            "referenceNumber3": "",
            "paymentOrigin": 3,
            "paymentMode": 15,
            "identificationNumber": "1036636123",
            "fullName": "Juan David Maya Galeano",
            "cellphoneNumber": "3215704751",
            "address": "P. Sherman 42 Wallaby Way Sydney",
            "email": "david@mayagaleano.com",
            "returnCode": "SUCCESS"
        }
    },
    "message": ""
}

Onboarding

POST

https://production.b2pagos.com

/api/v1/Onboarding/signup

requires authentication

Headers

Authorization

Example:

Bearer {PERSONAL_ACCESS_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

holder_name

string

required

Example:

nobis

holder_lastname

string

required

Example:

holder_sex_id

integer

required

1 = F, 2 = M

Example:

holder_birthday

string

required

Must be a valid date in the format Y-m-d.

Example:

2024-11-18

holder_document_type_id

integer

required

id from documentTypes endpoint

Example:

holder_document

integer

required

Example:

holder_phone

string

required

Example:

holder_email

string

required

value no es un correo válido.

Example:

predovic.marisol@example.org

holder_address

string

required

Example:

quis

holder_country_id

integer

required

id from countries endpoint

Example:

holder_city_id

integer

required

id from cities endpoint

Example:

21074

company_name

string

required

Example:

libero

company_service_description

string

required

value no debe ser mayor que 256 caracteres.

Example:

xkefvfuue

company_web

string

required

Must be a valid URL.

Example:

http://www.homenick.com/

company_address

string

required

Example:

delectus

company_warranty_description

string

required

value no debe ser mayor que 512 caracteres.

Example:

yjsqiapbxdkglfqpddsdsxk

company_document_type_id

integer

required

id from documentTypes endpoint

Example:

company_document

integer

required

Example:

company_bank_id

integer

required

id from Banks endpoint

Example:

company_bank_account_type_id

integer

required

1 = Ahorros 2 = Corriente

Example:

company_account

string

required

Example:

collect_mode

string

required

A = Agregador, G = GATEWAY

Example:

holder_photo

string

required

A base64 string

Example:

data:image/png;base64,iVBORw0KGgoAAAANS...

holder_signature

string

required

a base64 string

Example:

data:image/png;base64,iVBORw0KGgoAAAANS...

id_front_side

file

required

Must be a file.

Example:

/tmp/php9KltS7

id_back_side

file

required

Must be a file.

Example:

/tmp/phpuqwjLy

rut

file

required

Must be a file.

Example:

/tmp/phpFtyLVa

commerce_chamber

file

required

Must be a file.

Example:

/tmp/phpqoYGEs

contract

file

Must be a file.

Example:

/tmp/phpyrKwgS

bank_certification

file

required

Must be a file.

Example:

/tmp/phpHFEfTi

ciiu_code_id

integer

required

id from _ciiuCodes endpoint

Example:

398

agreement

string

Example:

est

Auth

Bearer

Headers

Body

Received response

Transacciones

getTransactionsBy

GET

https://production.b2pagos.com

/api/v1/transactions/getTransactionsBy/{account_id}/{by}/{value}

requires authentication

Headers

Authorization

Example:

Bearer {PERSONAL_ACCESS_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

account_id

integer

required

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

Example:

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:

page

number

Página de resultados.

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "success": false,
    "data": null,
    "meta": [],
    "message": "Unauthenticated."
}

disablePendingTransaction

PUT

https://production.b2pagos.com

/api/v1/transactions/disablePendingTransaction/{account_id}/{transaction_ide}

requires authentication

Headers

Authorization

Example:

Bearer {PERSONAL_ACCESS_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

account_id

integer

required

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

Example:

transaction_ide

string

required

Token de la transacción.

Example:

NjQ3N2UzMmRlOWE5YQ

Auth

Bearer

Headers

URL Parameters

Received response

Widgets

Webcheckout Widget

GET

https://production.b2pagos.com

/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.

1. Agrega a tu página web el siguiente recurso antes del cierre de tu etiqueta body


 ...
 <script src="https://production.b2pagos.com/widgets/assets/web-checkout-js"></script>

 </body>

2. En tu página web en donde quieras dar la opción de pago a tu cliente coloca el siguiente script:


<form
 gateway-webcheckout-widget="true"
 account-key="5dc153fa4d2a9b5dc15324d52065c83aaf0cf2999324d520589bfc3a592309c1"
 value="20000"
 reference="fe45689"
 description="descripción de la transacción"
 signature="23aed2b47f849e6955d883b6a0748df745258ec43481b7475123aed6955d8a4e"
 button-variation="1"
 redirect-url=""
>
</form>

3. Genera la firma de seguridad de la transacción (signature):

3.1. Genera tus llaves entrando a tu cuenta Clientes > Cuentas > Webcheckout Keys (o solicitalas al administrador de tu cuenta)

3.2. Una vez tengas tus llaves debes generar la firma de cada transacción generando un hash sha256
la debes generar concatenando los valores de accountKey.transactionValue.transactionReference.integrityKey
(no debes usar ningún carácter de concatenación y deben ser el el orden indicado)

   
   Ejemplo en php:

   //concepto
   hash('sha256', 'accountKey.value.reference.integrityKey')

   hash('sha256', $accountKey.$transactionValue.$transactionReference.$integrityKey)

   hash('sha256', 'a9efb0fa4d2a9b5dc15324d52065c83aaa9efb0fa4d2abe0589bfc3a592309c1'.'20000'.'fe45689'.'9ebd18a0cc2cc9ebd18a06fd8d8678f90922d4fa')

   //resultado: 48df74b47f849e6955d883b6a07f7e46b5258ec43481b7475123aed2493afa4e

   
   Ejemplo en Python:

   import hashlib

   data = 'a9efb0fa4d2a9b5dc15324d52065c83aaa9efb0fa4d2abe0589bfc3a592309c1' + '20000' + 'fe45689' + '9ebd18a0cc2cc9ebd18a06fd8d8678f90922d4fa'
   hashed = hashlib.sha256(data.encode()).hexdigest()

   
   Ejemplo en NodeJs:

   const crypto = require('crypto');

   const data = 'a9efb0fa4d2a9b5dc15324d52065c83aaa9efb0fa4d2abe0589bfc3a592309c1' + '20000' + 'fe45689' + '9ebd18a0cc2cc9ebd18a06fd8d8678f90922d4fa';
   const hashed = crypto.createHash('sha256').update(data).digest('hex');

Headers

Authorization

Example:

Bearer {PERSONAL_ACCESS_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example response:

Headers

                                                            content-type
                                                            : text/html; charset=UTF-8
                                                                                                                    cache-control
                                                            : no-cache, private
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 59
                                                                                                                    access-control-allow-origin
                                                            : *

API - DOCUMENTACIÓN

API - DOCUMENTACIÓN

Introduction

Authenticating requests

Generales

Obtener token de autenticación

Headers

Body Parameters

Obtener listado de cuentas

Headers

Obtener metodos de pago de una cuenta

Headers

Body Parameters

Obtener monedas disponibles

Headers

Obtener los impuestos disponibles

Headers

Obtener paises

Headers

Obtener regiones

Headers

URL Parameters

Obtener ciudades

Headers

URL Parameters

Obtener tipos de documentos

Headers

Obtener bancos PSE

Headers

Bancos

Headers

Query Parameters

Códigos CIIU

Headers

Query Parameters

Cobros

Generar un link de cobro

Headers

Body Parameters

Envia un SMS de cobro

Headers

Body Parameters

Envia un Whatsapp de cobro

Headers

Body Parameters

Envia un email de cobro

Headers

Body Parameters

Generar un QR de cobro

Headers

Body Parameters

Checkout

Crear una transacción

Headers

Body Parameters

Procesar pago PSE

Headers

Body Parameters

Procesar pago tarjeta

Headers

Body Parameters

Estado de transacción

Headers

Query Parameters

Onboarding

Register

Headers

Body Parameters

Transacciones

getTransactionsBy

Headers

URL Parameters

Query Parameters

disablePendingTransaction

Headers

URL Parameters

Widgets

Webcheckout Widget

Headers