Pagos

Con nuestra API tienes varios métodos de pago para ofrecer a tus clientes, a continuación podrás observar como realizar las peticiones para obtenerlos.

Listar métodos de pago

Dentro de la petición se debe especificar el id del usuario que tengas para obtener el listado exitoso de los diferentes recursos de pago que tienes disponibles para compartir al cliente.

Listado

POST https://sandbox.apagar.co/api/v1/payments/method/list

Request Body

Name	Type	Description
data*	Object	Datos principales
PaymentMethod*	Object	Método de Pago
type*	string	Tipo de metodos de pago
User*	Object	Datos de usuario
id	int	identificador del usuario

200 Listado generado

Request

{
  "data": {
    "paymentMethods": [
      {
        "id": 4,
        "name": "Credibanco",
        "type": "LINK",
        "icons": [
          {
            "url": "charge/mastercard.png",
            "width": 19
          },
          {
            "url": "charge/visa.png",
            "width": 27
          },
          {
            "url": "charge/american-express.png",
            "width": 35
          }
        ]
      },
      {
        "id": 7,
        "name": "Bancolombia",
        "type": "LINK",
        "icons": [
          {
            "url": "charge/bancolombia.png",
            "width": 84
          }
        ]
      },
      {
        "id": 8,
        "name": "ACH-PSE",
        "type": "LINK",
        "icons": [
          {
            "url": "charge/pse.png",
            "width": 77
          }
        ]
      },
      {
        "id": 9,
        "name": "Contraentrega",
        "type": "LINK",
        "icons": null
      }
    ]
  },
  "signature": null,
  "date": 1623358363596,
  "status": 200,
  "message": "Successful"
}

400: Bad Request No existen métodos de pago.

Generar Recurso de pago

Para generar un recurso de pago es necesario observar detenidamente cual opción de pago se quiere generar ya que dependiendo de ello la estructura del request , será diferente.

A continuación algunas recomendaciones para cada uno de las peticiones.

No olvides permanecer con la sesión de tu usuario activa para obtener el resultado de esta petición de manera correcta.

Para cada Método de pago QR, existe el dinámico y el estático. Lo único que cambia dentro de la petición es que el dinámico tiene el dato de monto y el estático no.

QR Dinámico Credibanco

{
    "data": {
        "PaymentMethod": {
            "id": 1,
            "features": {
                "Commerce": {
                    "Type": {
                        "id": 1
                    },
                    "City": {
                        "id": 898
                    }
                }
            }
        },
        "Bill": {
            "amount": 1000,
            "tax": 19,
            "Products": [
                {
                    "image": "https://cutt.ly/AmSBqyi",
                    "name": "Multiproducto",
                    "amount": 5000,
                    "tax": 8,
                    "description": "100 ml"
                }
            ]
        },
        "description": "Venta multiproducto"
    },
    "_channel": "web",
    "_deviceKey": "laptop"
}

QR Dinámico Bancolombia

QR Daviplata

Recuerda que los datos utilizados en las peticiones, son un ejemplo pero no deben ser utilizados.

Boton Bancolombia

{
    "data": {
        "PaymentMethod": {
            "id": 7
        },
        "Bill": {
            "amount": 1000,
            "tax": 19,
            "Products": [
                {
                    "image": "https://cutt.ly/AmSBqyi",
                    "name": "Multiproducto",
                    "amount": 5000,
                    "tax": 8,
                    "description": "100 ml"
                }
            ]
        },
        "description": "Venta multiproducto"
    },
    "_channel": "web",
    "_deviceKey": "laptop"
}

ACH PSE

Nequi

Daviplata

Para identificar a tu cliente en la generación del recurso de pago , deberás incluir en tu petición en el object Bill los campos de reference el id de tu cliente , tal como se muestra en la petición inferior Generación del recurso .

Así podrás identificar quien realizó la transferencia .

Generación del recurso

POST https://sandbox.apagar.co/api/v1/payments/resource/generate

Request Body

Name	Type	Description
data*	Object	Datos principales
PaymentMethod*	Object	Método de Pago
id*	int	Id del método o canal de pago
features*	Object	Objeto con todas las características adicionales para el método de pago
Commerce	Object	Objeto para tipo de comercio
type	Object	Objeto del tipo
id	int	id del metodo de pago
City	Object	objeto de ciudad
id	int	id de ciudad
Bill	object	Bill data
amount	int	Valor del recurso a generar
tax	int	IVA o impuesto del recurso a generar
Products	Object	lista donde cada objeto representara un producto
image	string	Ruta donde se aloja la imagen
name	string	Nombre del producto
amount	int	Valor del producto
tax	int	impuesto del producto
description	string	descripción del producto
cellphone	string	Numero del celular del cliente.
Reference	String	Id del cliente

200 Recurso generado

Request

{
    "data": {
        "PaymentMethod": {
            "id": 5
        },
        "Bill": {
            "tax": 19,
            "Products": [
                {
                    "image": "https://cutt.ly/AmSBqyi",
                    "name": "Multiproducto",
                    "amount": 5000,
                    "tax": 8,
                    "description": "100 ml"
                }
            ],
        "reference1": "reference1",
        "reference2": "reference2",
        "reference3": "reference3"
        },
        "description": "Venta multiproducto"
    },
    "_channel": "web",
    "_deviceKey": "laptop"
}

Response

{
    "data": {
        "Resource": {
            "id": 3698,
            "type": "SHARE",
            "data": "cc6****95d1e6c80ce1f6",
            "url": "https://sandbox.apagar.co/pagar/cc6a95d1e6c80ce1f6",
            "reference": "ccc6****95d1e6c80***f6",
            "createdAt": "2022-06-02 22:06:20",
            "expDate": "2022-06-02 22:26:20"
        }
    },
    "signature": "****533654a7854789487e7792dd6ed1d3326c7e",
    "date": 1654225580****,
    "status": 200,
    "message": "Successful"
}

401: Unauthorized Sesión terminada

400: Bad Request No existe el método de pago asociado al usuario

Generar recurso link de pago

Este recurso de pago generado a través de un link nos permite compartirlo al cliente a través de whatssap para así brindar mas opciones a nuestro cliente.

Generación del link del recurso de pago

POST https://sandbox.apagar.co/api/v1/payments/resource/generate

Request Body

Name	Type	Description
data*	Object	Datos principales
PaymentMethod*	Object	Método de Pago
id*	int	Id del método o canal de pago
features*	Object	Objeto con todas las características adicionales para el método de pago
Resource*	Object	Resource data
id*	int	id del recurso de pago
User*	Object	Dato de usuario
id*	int	id de usuario o comercio
typePerson*	String	Natural o jurídica
bank	int	id banco
docType*	String	Tipo de documento

200 Recurso generado

Request

{
  "data": {
    "reference": 6
  },
  "signature": "****06c9118b613bd3fb2aece63a5762c1c2d9e6",
  "date": 163355295****,
  "status": 200,
  "message": "Successful"
}

400: Bad Request Transacción finalizada