Crear un nuevo link de pago

post

https://api.payclip.com/v2/checkout

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.

🚧
Importante

Si actualmente consumes /v2/checkout desde frontend utilizando fetch(), te recomendamos migrar la integración a un backend intermedio para evitar problemas de CORS y proteger tus API Keys.

Puedes aceptar pagos en OXXO® habilitando en el elemento payment_method_types, el valor "cash" en tu integración.

Consulta cómo funciona el pago en efectivo en OXXO®

Llamada de prueba

Puedes realizar una llamada de prueba, únicamente asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha y dale click en el botón "Try It!":

Nota: Puedes consultar los mensajes de respuesta en este sección.

Body Params

amount

float

required

≥ 1

Defaults to 100.5

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

currency

string

required

length ≥ 3

Defaults to MXN

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

purchase_description

string

required

length ≤ 250

Defaults to ejemplo de compra

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

redirection_url

object

required

URLs para regresar a la tienda en línea después de completar una acción.

override_settings

object

Objeto que puedes utilizar para cambiar la configuración por default del Checkout.
Este objeto es opcional, si no se envía el payment_method se usará el valor por default.

expires_at

string

length ≤ 20

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
Si no se especifica, el valor default de este parámetro es tres días a partir de la hora de creación.

metadata

object

Objeto que puedes utilizar para identificar la transacción.
El conjunto de parejas llave:valor lo puede definir el desarrollador. El objeto se almacena como una cadena de texto (JSON) sin formato de estructura.
Este objeto es opcional, los elementos external_reference y customer_info se muestran como ejemplo.

custom_payment_options

object

Objeto con la configuración de los métodos de pago aceptados

webhook_url

string

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

Responses

Importante

Llamada de prueba

200OK

400Bad request

401Error de Autorización

403Prohibido

412Límite de solicitudes alcanzado

500Error de Servidor Interno