ComboPay API

Esta sección contiene una descripción general del próposito de la API de ComboPay. Nuestra API permite la mayor adaptabilidad técnica a sus sistemas existentes.

  • Versión: 1.0.0
  • Host: api.combopay.co
  • Protocolos: https
  • Acepta: application/json
  • Responde: application/json

Usando la API

Nuestra API le permitirá integrarse con ComboPay Payment Gateway utilizando un cliente HTTPS o REST en su lenguaje de programación preferido.

  • La versión actual de la API de ComboPay se encuentra en: https://api.combopay.co/
  • La versión de prueba descansa en: https://api-test.combopay.co/

Endpoints

Disponesmos de varios endpoints para iniciar sus flujos de pago:

  • Crear facturas.
  • Obtener facturas.
  • Obtener lista de facturas.
  • Crear transacción.
  • Calcular tarifa de comisión.
  • Lista de bancos PSE.

POST /api/authenticate

Obtener credenciales de atenticación de la API
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Cuerpo de Solicitud
{
    "email": "[email protected]",
    "password": 1234567890,
    "device_name": "API",
    "create_new": 0
  }

  email: string
  password: int
  device_name: string
  create_new: int
Respuesta
Ocultar contenido

POST /v1/invoices-list

Obterner listado de facturas
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Cuerpo de Solicitud
{
    "nit": "12345678900",
    "verification_digit": 0,
    "customer_document_type": "CC",
    "customer_document_number": "1234567890"
  }

  nit: string
  verification_digit: int
  customer_document_type: string
  customer_document_number: string
Respuesta
Ocultar contenido

GET /v1/commission-fee-calculate/ {amount}/{company_id}/{transaction_type_id}/{payment_method_id}/{cash_method_id}

Calcular comisión de transacción por método de pago.
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Cuerpo de Solicitud
Ocultar contenido
Respuesta
Ocultar contenido

GET /v1/pse-bank-list

Obtener listado de bancos para PSE.
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Respuesta
{
  "data":[
      {
          "id": 16,
          "name": "BANCOLOMBIA",
          "code": 1065,
          "active": 1
      }
  ]
}
data: array
id: string
name: string
code: int
active: int

GET /v1/get-invoice/{invoice}/{company_id}

Obterner datos de factura
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Cuerpo de Solicitud
Ocultar contenido
Respuesta
Ocultar contenido

POST /v1/invoices-create

Crea una factura que luego pueda compartir con el cliente para completar su proceso de recaudo
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Cuerpo de Solicitud
 
{
    "customer_name": "Nombre Cliente",
    "customer_email": "[email protected]",
    "customer_document_type": "CC",
    "customer_document_number": "1234567890",
    "invoice": "LK12345678",
    "status_paid": 0,
    "status_invoice": 1,
  }

  customer_name: string
  customer_email: string
  customer_document_type: string
  customer_document_number: string
  company_id: string
  invoice: string
  value: string
  description: string
  start_billing_period: string
  end_billing_period: string
  status_paid: int
  status_invoice: int
  custom: string"
  url_data_return: string
  url_client_redirect: string
Respuesta
Ocultar contenido

POST /v1/transaction-create

Crear Transacción.
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Cuerpo de Solicitud
{
    "invoice_id": 5,
    "payment_method_id": 3,
    "bank_code": 1007,
    "type_person": 0,
    "cash_method_id": 1,
    "customer_name": "Nombre Cliente",
    "customer_document_type": "CC",
    "customer_document_number": 123456789,
    "customer_email":[email protected]
}
    invoice_id: int
    payment_method_id: int
    bank_code: int
    type_person: int
    cash_method_id: int
    customer_name: string
    customer_document_type: string
    customer_document_number: int
    customer_email: string
Respuesta
{
    "data":{
        "status": true,
        "message": "Success pending transaction.",
        "response":{
            "CODE": "0000",
            "DATA":{
                "Monto": "103482.0",
                "OrdenID": "52491-1",
                "checkout": "sandbox-checkout.payvalida.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJNRVJDSEFOVF9DRUwiOiIrNTczMDE2NzAxMDQ4IiwiTUVSQ0hBTlRfQ09ERSI6MzA0MzgsIk9SREVSX0NPREUiOjIxMjEzNTYsIk1FUkNIQU5UX0VNQUlMIjoiIiwiTUVSQ0hBTlRfTE9HTyI6IiIsIk1FUkNIQU5UX1VSTF9SRVRVUk4iOiIiLCJNRVJDSEFOVF9OQU1FIjoiQ09NQk9QQVkiLCJFWFBJUkFUSU9OIjoiMTMvMDMvMjAyMSIsIk9SREVSX0JSSUVGIjoiRGVzY3JpcGNpw7NuIiwiT1JERVJfQ1VSUkVOQ1kiOiJDT1AiLCJPUkRFUl9BTU9VVCI6IjEwMzQ4Mi4wIiwiTUVSQ0hBTlRfSUQiOiJjb21ib3BsYXlzYXMiLCJPUkRFUl9SRUZFUkVOQ0UiOiI1MjQ5MSIsIk9SREVSX01FVEhPRCI6ImJhbmNvbG9tYmlhIiwiVVNFUl9ESSI6IjEyMzQ1Njc4OTA1NTQ4NTQ1MiIsIlVTRVJfVFlQRV9ESSI6IkNDIiwiVVNFUl9OQU1FIjoiTm9tYnJlIiwiUkVESVJFQ1RfVElNRU9VVCI6IiIsIk1FUkNIQU5UX1RFTVBMQVRFIjoidjQiLCJleHAiOjE2MTU2OTgwMDAsImlzcyI6ImF1dGgwIn0.TxObQ5iLQbKyEmLQm_JOjoe6SXeEf4YlhivRFH11qOQ",
                "Operacion": "CREADA",
                "PVordenID": "2121356",
                "Referencia": "52491"
            },
            "DESC": "OK"
        }
    },
    "response_code": 200
}
Ocultar contenido