v1

latestOpenAPI 3.0.0Apache 2.02026-07-24201159.6 KB
Checkout

Crear un nuevo link de pago

Genera un link de pago para redirigir a tus clientes al servicio de Checkout de Clip en donde pueden completar su pago de manera segura y rápida.

post/checkout

Request body

amountnumber float required

Número con decimales que representa el monto a cobrar. El número mínimo entero es 1. Utiliza dos decimales como máximo.

currencystring required

Código de tres caracteres que representa la moneda. <br/>Formato ISO 4217 (3 caracteres en mayúsculas).

purchase_descriptionstring utf-8 required

Texto que describe la compra. Visible para el cliente en la UI o el recibo. <br/>Formato UTF-8 <br/> Se aceptan los siguientes caracteres especiales `~!@#$%^&*()\=+\\|\[{\]};:"<>/?

expires_atstring YYYY-MM-DDTHH-MM-SSZ

Indica la fecha y hora (en UTC) de expiración de la solicitud de pago, la cual debe debe ser mayor a 00:01:00 minuto de la hora de creación de la solicitud y menor a las 23:59:59 (hora de CDMX) del mismo día de creación. Ejemplo 2023-06-18T22:52:26Z <br/> Si no se especifica, el valor default de este parámetro es tres días a partir de la hora de creación.

webhook_urlstring

URL del endpoint que recibirá notificaciones webhook del link de pago.<br/>Puedes consultar la estructura de la notificación webhook en el siguiente link.

Example request

{
  "metadata": {
    "me_reference_id": "OID123456789",
    "customer_info": {
      "name": "Juan Lopez",
      "email": "ejemplo@mail.com",
      "phone": 5512345678
    },
    "billing_address": {
      "zip_code": "03800A",
      "locality": "San Pedro",
      "city": "Benito Juárez",
      "State": "Ciudad de México",
      "country": "México",
      "street": "Av Uno",
      "outdoor_number": "104A",
      "interior_number": "203B",
      "reference": "Edificio gris",
      "between_streets": "Entre calle 13 y calle 9",
      "floor": "2B"
    }
  },
  "webhook_url": "https://hook.us1.make.com/k5f98kqxuuxgn4td6hgejrnu6lsi362p"
}

Response

OK

All 20 operations