Permite obtener el detalle de un pago específico.
El endpoint GET /payments/{payment_id} te permite obtener el detalle de un pago específico por medio del payment_id.
Header parameters (parámetros del encabezado)
La siguiente tabla describe el esquema de los parámetros del encabezado:
Parámetro |
Descripción |
Tipo |
Requerido / Opcional |
Notas |
|
Content-Type |
Define el formato del objeto de la llamada |
application/json |
Requerido |
Solicitud en formato JSON |
|
Authorization |
Especifica el token de acceso |
String |
Requerido |
token de autenticación |
Query parameters (parámetros del cuerpo de la solicitud)
La siguiente tabla describe el esquema de los parámetros de consulta:
Parámetro |
Descripción |
Tipo |
Ejemplo |
Requerido / Opcional |
Notas |
|
payment_id |
Identificador del pago del pago |
String |
"9154bbf8-e8cb-4e44-8412-d2b867c503” |
Requerido |
Número de identificación del pago. Formato: UUID. Solo requerido cuando se hace una consulta de un pago en específico. |
Respuesta
La respuesta contiene todos los elementos enviados en el body más los campos que se muestran en la siguiente tabla:
Parámetro |
Descripción |
Tipo |
Notas |
||
id |
Número de identificación de la transacción. |
String |
Formato: UUID |
||
amount |
Monto a cobrar |
Float |
Acepta 2 decimales como máximo |
||
tip_amount |
Propina sobre el precio del producto o servicio que se está pagando |
Float |
Si no hay propina se pasa un monto “0”. Acepta 2 decimales como máximo |
||
amount_refunded |
Cantidad reembolsada. |
Float |
En caso de existir un reembolso asociado con esta transacción se mostraría en este campo. |
||
installment_amount |
Monto de cada mensualidad. |
Float |
|
||
installments |
Meses sin intereses |
Number |
Los posibles valores pueden ser: 3, 6, 9, 12, 18, 24. El valor por default es 1, lo cuál significa que el pago no será diferido a meses. |
||
capture_method |
Modo de captura en el proceso de autorización y captura |
String |
Posibles valores: automatic o manual |
||
net_amount |
Monto cobrado sin incluir propina. |
Float |
Contiene máximo 2 decimales. |
||
paid_amount |
Monto cobrado incluyendo propinas. |
Float |
Contiene máximo 2 decimales. |
||
paid_amount |
Monto final transaccionado. |
Float |
Contiene máximo 2 decimales. |
||
country |
Código de país en ISO 3166 |
String |
País en donde se realizó el cargo. Siempre deberá ser MX |
||
currency |
Código de moneda en formato ISO 4217 alfabético |
String |
Únicamente puede ser MXN |
||
description |
Texto describiendo el cargo |
String |
Formato UTF-8. Se aceptan los siguientes caracteres especiales: ~!@#$%^&*()\\=+\\\\|\\[{\\]};:'\"/?. No se aceptan emojis. Longitud mínima: 1 Longitud máxima: 255 |
||
external_reference |
ID de referencia de la transacción para rastrear las transacciones |
String |
Longitud máxima: 36 caracteres. Caracteres especiales permitidos: Guión medio (-) y Guión bajo (_) Se permiten acentos. Los espacios en blanco serán removidos. |
||
customer |
Objeto con la información del cliente para el pago |
Objeto |
|
||
|
first_name |
Nombre del cliente que realiza la transacción. |
String |
|
|
|
last_name |
Apellido del cliente que realiza la transacción. |
String |
|
|
|
|
Correo electrónico del cliente que realiza la transacción. |
String |
|
|
|
phone |
Número telefónico del cliente que realiza la transacción. |
String |
|
|
|
description |
Texto describiendo al cliente. |
String |
|
|
|
address |
Objeto con la dirección de facturación. |
Objeto |
|
|
|
|
postal_code |
Código postal. |
String |
|
|
|
street |
Nombre de la calle. |
String |
|
|
|
number |
Número exterior del domicilio. |
String |
|
|
|
city |
Delegación o municipio. |
String |
|
|
|
country |
País. |
String |
|
|
|
state |
Estado. |
String |
|
|
identification |
Objeto con los datos de la identificación del cliente. |
Objeto |
|
|
|
|
id |
Número de identificación. |
String |
Número de folio o número de id |
|
|
type |
Tipo de identificación. |
String |
Tipos pueden ser: INE, pasaporte, CURP. |
payment_method |
Objeto con el método de pago utilizado para completar la transacción |
Objeto |
|
||
|
id |
Número de identificación |
String |
|
|
|
token |
Token ID de la tarjeta |
String |
El token que se genera por medio del endpoint de Card token |
|
|
type |
Tipo |
String |
|
|
|
card |
Objeto con la información de la tarjeta |
Objeto |
|
|
|
|
bin |
Número BIN |
String |
|
|
|
issuer |
Banco emisor |
String |
|
|
|
name |
Nombre en la tarjeta |
String |
|
|
|
country |
País |
String |
|
|
|
last_digits |
Últimos 4 dígitos del tarjeta |
String |
|
|
|
exp_year |
Año de expiración |
String |
|
|
|
exp_month |
Mes de expiración |
String |
|
receipt_no |
Número de recibo. |
String |
|
||
refunds |
Array con los reembolsos asociados a este pago |
Array |
|
||
status |
Estado del pago |
String |
|
||
status_detail |
Detalle del estado del pago |
Objeto |
|
||
|
code |
Código de estado |
String |
|
|
|
message |
Descripción del estado |
String |
|
|
pending_action |
Objeto de validación 3DS |
Objeto |
|
||
|
type |
Tipo de acción pendiente para validar |
String |
Único posible valor es “open_modal” |
|
|
url |
URL para realizar la validación 3DS |
String |
Contiene la URL a la cuál debes redirigir al cliente para hacer la validación 3DS. |
|
webhook_url |
URL del endpoint que recibirá notificaciones webhook del link de pago. |
String |
Puedes consultar la estructura de la notificación webhook en el siguiente link. |
||
created_at |
Fecha de creación. |
String |
Formato ISO 8601 ( YYYY-MM-DDTHH-MM-SSZ). |
||
approved_at |
Fecha de aprobación del pago. |
String |
Formato ISO 8601 ( YYYY-MM-DDTHH-MM-SSZ). |
Código de ejemplo
Ejemplo de una llamada.
El siguiente bloque de código muestra un ejemplo de la solicitud cURL:
curl --location 'https://api.payclip.com/payments/00d2b44e-d89c-432d-94e7-27cda1e0cd' \
--header 'Authorization: Basic MTBkMTA2Y2QtMTI4Ny00MjI1LWE0ZWQtNzY3MWRkM2Y5ZDEzOjExNWYwMjE0LWJkZDgtNGY1ZS04ODRmLWVhMTM0YjVhNTUyNA=='
Ejemplo de un objeto de la respuesta
El siguiente objeto es una respuesta de éxito con código HTTP 201 OK:
{
"id": "00d2b44e-d89c-432d-94e7-27cda1e0cd",
"amount": 0.01,
"tip_amount": 0,
"amount_refunded": 0,
"installment_amount": 0.01,
"installments": 1,
"capture_method": "automatic",
"net_amount": 0.01,
"paid_amount": 0.01,
"captured_amount": 0.01,
"binary_mode": false,
"approved_at": "2024-02-27T04:14:50.868762942Z",
"country": "MX",
"currency": "MXN",
"description": "Test Transparent Checkout API",
"external_reference": "",
"customer": {
"address": {
"city": "Benito Juárez",
"country": "México",
"colony": "San Pedro de los pinos",
"number": "118",
"postal_code": "03800",
"state": "ciudad de México",
"street": "Av Uno"
},
"description": "Descripción",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"identification": {
"id": "INE",
"type":"123456"
},
"phone": "5555555555"
},
"payment_method": {
"id": "master",
"type": "credit_card",
"card": {
"bin": "555555",
"issuer": "SANTANDER PR",
"name": "John Doe Doe",
"country": "MX",
"last_digits": "2222",
"exp_year": "99",
"exp_month": "12"
},
"token": "0915e7-f6f-862-89e-0c5d71ae6"
},
"pending_action": {},
"receipt_no": "SzWn",
"refunds": [],
"statement_descriptor": "",
"status": "approved",
"status_detail": {
"code": "AP-PAI01",
"message": "paid"
},
"metadata": {},
"return_url": "",
"webhook_url": "",
"created_at": "2024-02-27T04:14:49.687206862Z",
"version": 1
}
Códigos de respuesta
La siguiente tabla contiene una lista de los códigos de respuesta y su asociación con algunos de los estados HTTP:
404 |
BR1301 |
Not Found |
|
401 |
CL1501 |
Unauthorized |
|
500 |
AI1899 |
Internal error. |
Este es un ejemplo del objeto de error en formato JSON:
{
"error_code": "BR1301",
"message": "Not found",
"detail": [
"payment not found"
]
}
Llamada de prueba
Puedes realizar una llamada de prueba llenando los campos necesarios en el formulario que se muestra a continuación.
Asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha:
Por último dale click en el botón "Try It!":