Checkout

Consulta el estado de un link de pago

Changed on Nov 3, 2026

Consulta el estado de un link de pago.

get/checkout/{payment_request_id}

Request

Base URL
https://api.payclip.com/v2
URL
https://api.payclip.com/v2/checkout/{payment_request_id}
Auth
API key in header Authorization

Path parameters

payment_request_idstring UUID required

Identificador del link de pago. Se genera un nuevo <code>payment_request_id</code> en cada solicitud para Crear un nuevo link de pago.

Response

amountnumber float

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

receipt_nostring

Identificador de la transacción, se mostrará en el evoucher de la transacción. Este campo se muestra cuando el valor de status es CHECKOUT_COMPLETED

object_typestring

Valor estático del link de pago "payment_link"

created_atstring YYYY-MM-DDTHH-MM-SSZ

Indica la fecha y hora de creación del enlace de pago.

expired_atstring date-time

Indica la fecha y hora de expiración del enlace de pago.

payment_request_idstring uuid

Identificador del link de pago. Se genera un nuevo <code>payment_request_id</code> en cada solicitud para Crear un nuevo link de pago.

purchase_descriptionstring

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

last_status_messagestring

Mensaje del último estado del link de pago dependiendo del elemento status.

payment_request_urlstring

Link de pago a donde se redirigirá al cliente.

currencystring

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

modified_atstring

Indica la fecha y hora de modificación del enlace de pago.

statusstring

Estado actual del link de pago. Los estados posibles son CHECKOUT_CREATED El link de pago fue creado exitosamente. CHECKOUT_PENDING El link de pago está activo y pendiente de ser completado. CHECKOUT_CANCELLED El link de pago fue cancelado por exceso de intentos (máximo 5). CHECKOUT_EXPIRED El link de pago expiró. El link de pago expira después de 1 hora. CHECKOUT_COMPLETED El link de pago se liquidó.

Example response

{
  "metadata": {
    "customer_info": {
      "phone": 5512345678,
      "name": "Alejandro Lee",
      "email": "buyer@mail.com"
    },
    "external_reference": "OID123456789"
  },
  "amount": 100.55,
  "receipt_no": "EyCtYWF",
  "object_type": "payment_link",
  "created_at": "2020-04-30T00:00:00.000Z",
  "expired_at": "2020-04-30T00:00:00.000Z",
  "payment_request_id": "2cbf5775-1cdd-4601-9712-c4a6ab7fa6f5",
  "purchase_description": "Backpack's sale",
  "last_status_message": "Payment request is active",
  "payment_request_url": "https://completa-tu-pago.payclip.com/2cbf5775-1cdd-4601-9712-c4a6ab7fa6f5",
  "redirection_url": {
    "default": "https://my-website.com/redirection/default",
    "success": "https://my-website.com/redirection/success?external_reference=OID123456789",
    "error": "https://my-website.com/redirection/error?external_reference=OID123456789"
  },
  "currency": "MXN",
  "modified_at": "2020-04-30T00:00:00.000Z",
  "status": "CHECKOUT_COMPLETED"
}

Changes

Nov 3, 20265e6b0919ea8b Revision changes
- breaking
  media type application/vnd.com.payclip.v2+json was changed to a more general media type application/json for the response status
- breaking
  media type application/vnd.com.payclip.v2+json was changed to a more general media type application/json for the response status
- breaking
  media type application/vnd.com.payclip.v2+json was changed to a more general media type application/json for the response status
- breaking
  media type application/vnd.com.payclip.v2+json was changed to a more general media type application/json for the response status
- breaking
  media type application/vnd.com.payclip.v2+json was changed to a more general media type application/json for the response status
- breaking
  media type application/vnd.com.payclip.v2+json was changed to a more general media type application/json for the response status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  removed the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status

Operation history