Retorna los detalles de una factura específica usando su ID.
Este endpoint regresa los detalles de una factura o pago específico por medio de su id.
Header parameters
La siguiente tabla describe el esquema de los parámetros de encabezado o headers:
|
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 |
|
Path parameters
La siguiente tabla describe el esquema de los parámetros de ruta:
|
Parámetro |
Descripción |
Tipo |
Requerido / Opcional |
Ejemplo |
Notas |
|
|
invoice_id |
id del invoice. |
String |
Requerido |
1960c5eb-d9ed-4a55-8d65-a377b5 |
UUID v4 |
|
Código de ejemplo
Ejemplo de una solicitud.
El siguiente bloque de código es un ejemplo de una solicitud realizada al endpoint GET /subscriptions/{subscription_id}:
curl --location 'https://api.payclip.com/invoices/5529d231-b3eb-4516-80d1-43db79e79c29' \
--header 'Authorization: Basic MTBkMTA2Y2QtMTINWYwMjE0LWJkZDgtNGY1ZS04ODRmLWVhMTM0YjVhNTUyNA==' \
--header 'Content-Type: application/json'
Ejemplo de una respuesta.
El siguiente objeto es una respuesta de éxito con código HTTP 200 OK:
{
"id": "5529d231-b3eb-4516-80d1-43db79e79c29",
"subscription_id": "61bcae6f-1919-4d1a-92aa-2648b36d3be1",
"payment_request_id": "214d8cd2-9ebc-4372-9b06-cbaa26fc862e",
"amount": 90.00,
"due_date": "2024-04-02T00:00:00Z",
"status": "paid"
}
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:
|
Estado HTTP |
Error code |
Mensaje |
|
|
401 |
CL1501 |
Unauthorized |
|
|
404 |
BR1301 |
Price Object not found |
|
|
500 |
AI1899 |
Internal error. |
|
Ejemplo de una respuesta conteniendo un código de error en formato JSON. En este ejemplo se comparte el código de error en el campo “error_code”, la descripción en el campo “message” y dentro del objeto “detail” más información:
{
"error_code": "BR1302",
"message": "Internal Error",
"detail": [
"Invoice object not found"
]
}
Llamada de prueba
Puedes realizar una llamada de prueba llenando los campos necesarios en el formulario que se muestra abajo.
Asegúrate de poner tu token de autenticación en el campo "Header: Autorization" del widget localizado a tu derecha y dale click en "Try It!":
