Pagos

Los servicios que veras a continuación son los que te permitirán generar un recurso de pago dependiendo tu necesidad .

1. Link de pago ( Pasarela con todos los medios de pago) .

2. Método de pago ( Método de pago en especifico).

Para consumir los servicios anteriores se deberá utilizar el token transaccional generado en el modulo "Token transaccional", éste se deberá agregar en los headers de la siguiente manera :

Key : x-transaction-token

Value : 9b48edde-652d-11ed-984e-02c840fe****

Campos importantes dentro de las peticiones:

Webhook: Es la url del webhook del cliente a donde nuestro servicio envía la información de los estados de las transacciones y detalle de la misma.

ReturnUrl: Este campo que se encuentra en la siguiente petición, es utilizado para definir a qué vista debe retornar el usuario cuando finalice el pago y oprima el botón de retornar al comercio. Por defecto estará la de Refácil.

Si deseas saber con cuales proveedores puedes realizar un flujo de pago completo, solo deberás dar clic en el siguiente link:

Proveedores - Ambiente de pruebas

Generar recurso con Link de Pago

Con la siguiente petición podrás obtener un recurso de pago con link que redirigirá a tu cliente a la pasarela de pago donde visualizará un listado con los diferentes métodos de pago disponibles.

POST https://pay-api.qa.refacil.co/cash-in/generate/payment-link/token

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
x-transaction-token	9b48edde-652d-11ed-984e-02c840fe****

Body

Name	Type	Description
amount*	number	Valor del pago.
webhookUrl*	string	URL del webhook del cliente.
returnUrl	string	Enlace que verá el cliente al hacer clic en el botón de retorno al comercio.
expiresIn	number	Tiempo en segundos para la expiración del recurso o link de pago.
brandId*	number	ID de la marca blanca del cliente; si no se cuenta con una, se envía el ID 79 por defecto.
showSummary	string	Indica si se mostrará o no el resumen de pago RefácilPay (false: no mostrar, true: mostrar).
reference1*	string	Identificador del cliente, no debe superar los 20 caracteres.
reference2	object	Objeto para información adicional.
Label	string	Objeto para enviar información que se visualizará en el resumen de pago.
Data	string	Objeto para información relacionada con la conciliación de la transacción.

200: OK Exitosa

Request

{
    "expiresIn": 0,
    "amount": 18000,
    "brandId": 61,
    "webhookUrl": "https://****gerstg.azure-api.net/SkCo.PagosEnLinea.API/payonline/PostStatus",
    "returnUrl": "https://www.google.com/",
    "showSummary": true,
    "reference1": "CGOOsiYQspMpgDD",
    "reference2": {
        "Label": {
            "Name": "Juanita Perez",
            "Email": "pqacLO87V77DgF62P8PXENA==do",
            "CellPhone": "1VM6daPPJcXCD4Cw93272oQ==8",
            "PersonType": "N",
            "DocumentType": "C",
            "DocumentNumber": 79706920
        },
        "Data": {
            "Typedoc": "cedula",
            "docnum": "1088307172"
        }
    }
}

Response

{
    "statusCode": "00",
    "message": "Operación exitosa.",
    "data": {
        "url": "https://app.qa.refacil.co/refacilpay/payLink/61/0e9324d0-77df-11ed-a59f-a70d92dacf57",
        "reference": "0e9324d0-77df-11ed-a59f-a70d92dac***"
    }
}

401: Unauthorized Sin permisos

Response

{
  "message": "Autenticación no encontrada",
  "statusCode": "01",
  "data": {}
}

Generar recurso con medio de pago

Dentro de la siguiente petición se generará link para un medio de pago en especifico, por tanto es indispensable indicar el ID del método de pago a utilizar.

A continuación se relacionan los ID por cada método de pago disponible en nuestro API:

129 - Bancolombia Qr

130 - Nequi

131 - Daviplata

132 - Bancolombia Button

133 - PSE

134 - IPay

153 - Recaudo Efectivo

155 - Transfiya recaudo

163 - TPaga

Configuración adicional para métodos de pago específicos

Para los métodos de pago PSE, Nequi, Daviplata y Transfiya Recaudo, el objeto paymentMethod dentro del cuerpo de la solicitud, además de incluir el ID del método de pago, debe especificar otros parámetros adicionales que se detallan a continuación.

Para los demás métodos de pago, la estructura sigue siendo la misma como en los siguientes ejemplos.

Bancolombia Qr

{
    "paymentMethod": {
        "id": 129
    }
}

Nequi

{
    "paymentMethod": {
        "id": 130,
        "cellphone": "3105293225"
    }
}

Daviplata

{
    "paymentMethod": {
        "id": 131,
        "cellphone": "3208385715"
    }
}

Bancolombia Button

{
    "paymentMethod": {
        "id": 132
    }
}

PSE

{
    "paymentMethod": {
        "id": 133,
        "documentType": "CC",
        "typePerson": "0",
        "bankId": "string",
        "documentNumber": "string",
        "name": "string",
        "cellphone": "string",
        "address": "string",
        "email": "string"
    }
}

Tener en cuenta la siguiente información:

"typePerson":"0" Corresponde a Tipo de persona Natural 
y solo aceptará en "documentType" los siguientes:
    RCN = 'RegistroCivilDeNacimiento'
    TI = 'TarjetaDeIdentidad'
    CC = 'CedulaDeCiudadania'
    TE = 'TarjetaDeExtranjeria'
    CE = 'CedulaDeExtranjeria'
    PA = 'Pasaporte'
    DIE = 'DocumentoDeIdentificacionExtranjero'

"typePerson":"1" Corresponde a Tipo de persona Jurídica y solo aceptará en "documentType" los siguientes:
    NIT = 'nit' 

IPay

{
    "paymentMethod": {
        "id": 134
    }
}

Recaudo Efectivo

{
    "paymentMethod": {
        "id": 153
    }
}

Transfiya recaudo

{
    "paymentMethod": {
        "id": 155,
        "cellphone": "3105293225"
    }
}

TPaga

{
    "paymentMethod": {
        "id": 163
    }
}

POST https://pay-api.qa.refacil.co/cash-in/generate/payment-method/token

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>
x-transaction-token	9b48edde-652d-11ed-984e-02c840fe****

Body

Name	Type	Description
expiresIn	number	Tiempo en segundos de la expiración del recurso o link de pago (debe ser mayor que el tiempo mínimo de vida definido por el medio de pago seleccionado).
webhookUrl*	string	URL del webhook del cliente.
returnUrl	string	Enlace que verá el cliente al hacer clic en el botón de retorno al comercio.
showSummary	string	Indica si se mostrará o no el resumen de pago RefácilPay (false: no mostrar, true: mostrar).
reference1*	string	Identificador del cliente, no debe superar los 20 caracteres.
reference2	object	Objeto para información adicional.
amount*	number	Valor del pago.
Label	object	Objeto para enviar información que se visualizará en el resumen de pago.
Data	object	Objeto para información relacionada con la conciliación de la transacción.
brandId*	number	ID de la marca blanca del cliente; si no se cuenta con una, se envía el ID 79 por defecto.
paymentMethod *	object	Objeto que contiene el método de pago seleccionado.
id*	number	Identificación del método de pago.

A continuación, se detallan los tiempos mínimos de expiración requeridos para generar un recurso de pago, según el medio de pago seleccionado:

• QR Bancolombia: 1800 segundos (30 minutos)

• Botón Bancolombia: 720 segundos (12 minutos)

• Daviplata: 43200 segundos (12 horas)

• Nequi: 43200 segundos (12 horas)

• Transfiya Recaudo: 43200 segundos (12 horas)

• PSE: 1800 segundos (30 minutos)

Estos tiempos mínimos deben ser superados en el campo expiresIn al realizar una solicitud de pago, asegurando así que el recurso sea válido según las especificaciones del medio de pago correspondiente.

200: OK Exitosa

Request

{
    "expiresIn": 0,
    "paymentMethod": {
        "id": 155,
        "cellphone": "3051000002"
    },
    "amount": 10000,
    "brandId": 1,
    "webhookUrl": "https://webhook.site/271888cd-bd07-469a-88a8-e0ed7e93c368",
    "returnUrl": "https://www.google.com/?hl=es",
    "showSummary": true,
    "reference1": "EGfbOsiYQspMpgDD",
    "reference2": {
        "Label": {
            "Campos": "string"
        }
    }
}

Response

{
    "statusCode": "00",
    "message": "Operación exitosa.",
    "data": {
        "url": "https://app.qa.refacil.co/refacilpay/resumen/1/431300f0-66d9-11ef-87eb-f969c0f10b10",
        "reference": "431300f0-66d9-11ef-87eb-f969c0f10b10",
        "resourceId": "7001472",
        "expiresIn": "2024-08-31T14:07:59.031Z",
        "status": 1
    }
}

401: Unauthorized Sin permisos

Response

{
"message": "Autenticación no encontrada",
  "statusCode": "01",
  "data": {}
}