Crear un nuevo link de pago

post https://api-gw.payclip.com/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

Para poder hacer solicitudes a la API de Checkout, necesitas tener un token de autenticación y una cuenta de Clip.

Para poder integrar la API de Checkout en tu ecommerce, es recomendable ser desarrollador fullstack.

Completa la sección de body params ubicada a continuación y presiona el botón Try it!. La llamada de solicitud se llenará automáticamente con la información que le proporciones.

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.

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 me_reference_id y customer_info se muestran como ejemplo.

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.

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

Language

Credentials

Header


xxxxxxxxxx
16
1
curl --request POST \
2
     --url https://api-gw.payclip.com/checkout \
3
     --header 'accept: application/vnd.com.payclip.v2+json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "amount": 100.5,
8
  "currency": "MXN",
9
  "purchase_description": "ejemplo de compra",
10
  "redirection_url": {
11
    "success": "https://my-website.com/redirection/success?me_reference_id=OID123456789",
12
    "error": "https://my-website.com/redirection/error?me_reference_id=OID123456789",
13
    "default": "https://my-website.com/redirection/default"
14
  }
15
}
16
'

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.com.payclip.v2+json

Contáctanos

Crear un nuevo link de pago

🚧
Importante

Contáctanos

🚧Importante

200OK

400Solicitud incorrecta

401Error de Autorización

403Prohibido

404No Encontrada

412Límite de solicitudes alcanzado

500Error de Servidor Interno

🚧
Importante