Links de pago

Un link de pago es una URL que permite a los usuarios completar un pago de forma rápida y fácil. Puede ser compartido por correo, redes sociales o mensajes de texto.

POST/api/payment-link

Crear un link

Este endpoint permite crear un link de pago y configurarlo de acuerdo a tus necesidades

Solicitud

Name
auth
Type
object
is Required
REQUIRED
Description
La autenticación del sitio. Ver más en Autenticación
Name
notificationUrl
Type
string
is optional
Description
URL a la que se enviarán las notificaciones de los pagos realizados a través del link de pago, así como las notificaciones de expiración del link. Para más detalles, visita Notificación.

EJ: https://webhook-test.com
Name
locale
Type
string
is optional
Description
Idioma en que sera enviado y se mostrara el link de pago, visita Localización para conocer sus valores permitidos

EJ: es_CO
Valores permitidos:enesptitfr
Name
name
Type
string
is Required
REQUIRED
Description
Nombre que será asociado al link de pago.

EJ: my-product-name
Name
paymentsAllowed
Type
integer
is optional
Description
Número de pagos que se podrán realizar a través del link. Si este campo no se envía, el link permitirá una cantidad ilimitada de pagos..

EJ: 7
Name
expirationDate
Type
string
is Required
REQUIRED
Description
Fecha y hora en la que el link dejará de estar activo. La fecha debe ser posterior a la fecha y hora actual del usuario.

EJ: 2023-10-21 16:40:10
Name
paymentExpiration
Type
integer
is Required
REQUIRED
Description
Cantidad de tiempo en minutos permitido para completar cada sesión de Checkout.

EJ: 15
Name
payment
Type
object
is Required
REQUIRED
Description
Información del pago que se realizará a través del link de pago.
Name
reference
Type
string
is Required
REQUIRED
Description
Referencia única asociada al link de pago.

EJ: Reference123
Name
description
Type
string
is Required
REQUIRED
Description
Descripción asociada al link de pago.

EJ: Descripción de mi producto
Name
paymentMethod
Type
array
is optional
Description
Métodos de pago permitidos para usar en el link de pago creado. Solo se pueden enviar métodos de pago que estén habilitados en tu sitio.

EJ: ["pse", "visa", "master"]
Name
receiverEmails
Type
array
is optional
Description
Lista de correos electrónicos a los que se enviará el link una vez que se haya creado correctamente.

EJ: ["[email protected]", "[email protected]"]
Name
additional
Type
object
is optional
Description
Campos adicionales para el link de pago. algunos campos de adicionales que podrias utilizar son:

Solicitud

POST

/api/payment-link

curl -X "POST"	https://sites.placetopay.com/api/payment-link \
-H "Content-Type: application/json" \
-d '{
    "auth": {
        "login":"aabbccdd1234567890aabbccdd123456",
        "tranKey":"ABC123example456trankey+789abc012def3456ABC=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
    },
    "notificationUrl": "https://webhook-test.com",
    "locale": "es_CO",
    "name": "Prueba",
    "paymentsAllowed": 7,
    "expirationDate": "2024-08-12 08:10:50",
    "paymentExpiration": 15,
    "payment": {
        "amount": {
            "currency": "COP",
            "total": 100000,
            "taxes": [
                {
                    "kind": "valueAddedTax",
                    "amount": 20000,
                    "base": 1000
                },
                {
                    "kind": "municipalTax",
                    "amount": 5000,
                    "base": 2000
                }
            ]
        },
        "modifiers": [
            {
                "type": "FEDERAL_GOVERNMENT",
                "code": 17934,
                "additional": {
                    "invoice": "12334577"
                }
            }
        ]
    },
    "reference": "#5321",
    "description": "Pago por infraccion",
    "paymentMethod": ["pse", "visa"],
    "receiverEmails": ["[email protected]", "[email protected]"],
    "additional": {
        "buyer_email": "[email protected]",
        "buyer_name": "Billy"
    }
}'

Respuesta

Link de pago creado correctamente

Name
status
Type
object
is Required
REQUIRED
Description
Objeto status contiene la información del estado de la solicitud
Name
id
Type
integer
is optional
Description
ID único e incremental del link de pago creado, este ID es el que se usará para consultar la información del link de pago.

EJ: 1
Name
url
Type
string
is optional
Description
URL del link de pago. Esta URL es la que se debe enviar al comprador para que pueda realizar el pago.

EJ: http://microsites.test/link/show?genid=27&code=47

Respuesta

{
    "status": {
        "status": "OK",
        "reason": 201,
        "message": "Link de pago creado y correos electrónicos enviados correctamente.",
        "date": "2024-07-31T11:36:23-05:00"
    },
    "id": 1,
    "url": "http://microsites.test/link/show?genid=22&code=190"
}

POST/api/payment-link/{link_id}

Consultar un link

Este endpoint permite consultar un link de pago y obtener información detallada sobre el mismo. Si el link contiene pagos, también se mostrarán en la respuesta.

Solicitud

Name
auth
Type
object
is Required
REQUIRED
Description
El objeto auth es obligatorio para lograr conectarse de forma segura a nuestros servicios

Solicitud

POST

/api/payment-link/{link_id}

curl -X "POST" https://sites.placetopay.com/api/payment-link/{link_id}\
-H "Content-Type: application/json" \
-d '{
    "auth": {
        "login":"aabbccdd1234567890aabbccdd123456",
        "tranKey":"ABC123example456trankey+789abc012def3456ABC=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
    }
}'

Respuesta

Link de pago consultado correctamente

Name
id
Type
integer
is Required
REQUIRED
Description
ID del link consultado.

EJ: 21
Name
status
Type
string
is Required
REQUIRED
Description
Estado del link consultado.

EJ: ACTIVE
Valores permitidos:ACTIVEINACTIVEEXPIRED
Name
url
Type
string
is Required
REQUIRED
Description
URL del link consultado.

EJ: http://microsites.test/link/show?genid=26&code=47
Name
expirationDate
Type
string
is optional
Description
Fecha y hora de expiración del link consultado en formato UTC.

EJ: 2024-08-12T08:10:50-05:00
Name
name
Type
string
is Required
REQUIRED
Description
Nombre asociado al link consultado.

EJ: Prueba
Name
reference
Type
string
is Required
REQUIRED
Description
Referencia asociada al link consultado.

EJ: #5321
Name
description
Type
string
is Required
REQUIRED
Description
Descripción asociada al link de pago.

EJ: Descripción de un link de pago
Name
totalPayments
Type
integer
is optional
Description
Cantidad de pagos permitidos a través del link consultado.

EJ: 7
Name
availablePayments
Type
integer
is optional
Description
Cantidad de pagos disponibles en el link consultado.

EJ: 6
Name
paymentExpiration
Type
integer
is optional
Description
Minutos que dura una sesión de pago antes de expirar.

EJ: 15
Name
amount
Type
integer
is Required
REQUIRED
Description
Información del monto a cobrar a través del link de pago
Name
site
Type
object
is Required
REQUIRED
Description
Información del sitio asociado al link de pago.
Name
metadata
Type
object
is optional
Description
Información adicional asociada al link de pago.

EJ: {"discount":[{"code":17934,"type":"FEDERAL_GOVERNMENT","additional":{"invoice":"123456777"}}]}
Name
payments
Type
array
is optional
Description
Lista que contiene todos los pagos realizados a través del link. Si no se ha realizado ningún pago, este campo se mostrará como un array vacío.

Respuesta

{
    "id": 21,
    "status": "ACTIVE",
    "url": "http://microsites.test/link/show?genid=21&code=ce350a956700cee9e29446a552201ddd55c6a477",
    "expirationDate": "2024-08-12 08:10:50",
    "name": "Prueba",
    "reference": "#5321",
    "description": "Pago por infraccion",
    "totalPayments": 7,
    "availablePayments": 6,
    "paymentExpiration": 15,
    "amount": {
      "currency": "COP",
      "total": 100000,
      "taxes": [
        {
          "base": 80000,
          "kind": "valueAddedTax",
          "amount": 20000
        },
        {
          "base": 50000,
          "kind": "municipalTax",
          "amount": 5000
        }
      ]
    },
    "site": {
        "id": 1469,
        "name": "Evertec - API Link de pagos"
    },
    "notificationUrl": "https://webhook-test.com/dc45064451b3b0fdc61d8d5be632d450",
    "locale": "es_CO",
    "allowedPaymentMethods": [
        "pse",
        "visa"
    ],
    "metadata": {
      "discount": [
        {
          "code": 17934,
          "type": "FEDERAL_GOVERNMENT",
          "additional": {
            "invoice": "123456777"
          }
        }
      ]
    },
    "payments": [
      {
        "id": 8,
        "requestId": 84076,
        "status": "APPROVED",
        "message": "La petición ha sido aprobada exitosamente",
        "processUrl": "https://checkout-co.placetopay.dev/spa/session/84076/79e4267e26771ed8ecffdab18d4c5f69",
        "amount": {
          "currency": "COP",
          "total": "100000.00"
        },
        "receipt": "99900100",
        "franchise": "CR_VS",
        "paymentMethod": "visa",
        "paymentDate": "2024-07-26 08:21:40",
        "internalReference": 434915,
        "authorization": "000000",
        "issuerName": "JPMORGAN CHASE BANK, N.A.",
        "merchantCode": "012988341",
        "terminalNumber": "00022645",
        "installments": 1,
        "lastDigits": "1111",
        "payer": {
          "name": "Andres",
          "surname": "Zea",
          "email": "[email protected]",
          "phone": "+573135911356",
          "document": "1001221123",
          "documentType": "CC"
        }
      }
    ]
}

POST/api/payment-link/disable/{link_id}

Deshabilitar un link

Este endpoint permite desactivar un link de pago lo que impedira que se realicen mas pagos a traves de el

Solicitud

Name
auth
Type
object
is Required
REQUIRED
Description
El objeto auth es obligatorio para lograr conectarse de forma segura a nuestros servicios

Solicitud

POST

/api/payment-link/disalbe/{link_id}

curl -X "POST" https://sites.placetopay.com/api/payment-link/disalbe/{link_id} \
-H "Content-Type: application/json" \
-d '{
    "auth": {
        "login":"aabbccdd1234567890aabbccdd123456",
        "tranKey":"ABC123example456trankey+789abc012def3456ABC=",
        "nonce":"NjE0OWVkODgwYjNhNw==",
        "seed":"2021-09-21T09:34:48-05:00"
    }
}'

Respuesta

Link de pago desactivado exitosamente

Name
status
Type
object
is Required
REQUIRED
Description
Objeto status contiene la información del estado de la solicitud
Name
id
Type
string
is Required
REQUIRED
Description
ID del link que ha sido desactivado.

Respuesta

{
    "status": {
        "status": "OK",
        "reason": 200,
        "message": "Link de pago desactivado correctamente.",
        "date": "2024-07-31T14:19:22-05:00"
    },
    "id": 24
}