ComboPay API Beta

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: Beta
  • Host: api.mirecaudo.com
  • 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 beta de la API de ComboPay se encuentra en: https://api.mirecaudo.com/
  • La versión de prueba descansa en: https://api-test.mirecaudo.com/

Endpoints

Disponesmos de varios endpoints para iniciar sus flujos de pago:
  • Autenticación.
  • Solicitar enlace de pago.
  • Solicitar estado de la transacción.
  • Solicitar listado de facturas.

POST api/oauth/token

Obtener credenciales de autenticación de la API
Cuerpo de Solicitud
{
    "grant_type": "password",
    "client_secret": "client_secret",
    "username": "[email protected]",
    "password": password_comercio,
    "client_id": "client_id_comercio"
  }
Respuesta
{
    token_type: "Bearer",
    expires_in: 1586011687129,
    access_token: Código,
    refresh_token: Código
    }

POST api/company/company_id/invoices

Obterner listado de facturas
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Cuerpo de Solicitud
{
    customerDocument: número de documento del cliente,
    invoiceNumber: número de factura,
    perPage: cantidad de datos en la respuesta,
    customInfo: valor almacenado en el campo custom de las facturas,
    status: estado del pago pago (pagada=1, pendiente=0),
    active: estado general de la factura activa o inactiva,
    orderBy: ordenamiento (asc, desc),
    field: campo para discriminar ordenamiento
  }
Respuesta
{
     id:int
     invoice:string
     document:string
     collect_to:any
     value:float
     tax_value:any
     start_billing_period:string
     end_billing_period:string
     description:string
     status:int
     created_at:string
     updated_at:string
     deleted_at:any
     email_collect_to:any
     active:string
     custom:string
     url_data_return:any
     url_client_redirect:string
 }

GET api/invoices/factura_id/transactions

Es posible desde tu sitio web consultar el estado de la transaccion relacionado a tu factura consumiendo este recurso
Solicitar Parámetros
Authorization => Bearer codigo_autorizacion
Respuesta
{
   "data": [
        {
            "id":725,
            "payment_method_id":1,
            "trazability_code":"596348501",
            "payment_config":null,
            "ticket_number":"1586443075",
            "response_type":"create",
            "paid_transaction":null,
            "fail_transaction":null
            },
        {
            "id": 727,
            "payment_method_id": 1,
            "trazability_code": "596348501",
            "payment_config": null,
            "ticket_number": "1586443075",
            "response_type": "information",
            "paid_transaction": {
                "payment_date">: "2020-04-09 14:04:09">,
                "payment_platform">: "pse">,
                "payment_source">: "D\u00e9bito">,
                "payment_branch">: "D\u00e9bito en Cuenta">,
                "ip_address">: "162.158.75.21">
            },
            "fail_transaction": null
        },
        {
            "id": 20688,
            "payment_method_id": null,
            "trazability_code": "596348501",
            "payment_config": null,
            "ticket_number": "1586443075725",
            "response_type": "finalize",
            "paid_transaction": null,
            "fail_transaction": null
        }
    ]
}

POST api/invoice-company-customer

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
{
    "name": string,
    "document_type": string -> tipo constantes,
    "document": string,
    "phone_number": string,
    "email": string,
    "invoice": string único,
    "value": string 191,
    "tax_value": int,
    "description": string,
    "start_billing_period": fecha Y-m-d 0000-00-00,
    "end_billing_period": fecha Y-m-d 0000-00-00,
    "url_data_return": string -> URL donde se retorna el estado final de la transacción,
    "url_client_redirect": string -> URL donde se direcciona al cliente una vez finalizada la transacción,
    "active": string -> puede ser activa o inactiva,
    "custom": string -> puede ser cualquier string
  }
Respuesta
{
        payment_link: string -> url de pago mirecaudo.com
        id: numerico
        invoice: string
        document: string
        collect_to: string
        value: float
        tax_value: int
        start_billing_period: string
        end_billing_period: string
        description: string
        status: boolean -> 0 = no pagado -> 1 = pagado
        created_at: string
        updated_at: string
        deleted_at: string
        email_collect_to: string
        companies_invoice: [
            {
              id: int, 
              name: string, 
              business_name: string, 
              slug_business_name: string
            }
        ]
        customers: [
            {
                id: int
                name: string
                email: string
                document_type: string
                document: string
                phone_number: string
                city_id: int
                created_at: string
                updated_at: string
            }
        ]
    }