Te permite integrar tu sitio web o aplicación a Paggo.API para que puedas gestionar y dar seguimiento a tus links y vouchers de pago. Esto también te permite tener reportes de las transacciones generadas a través de nuestra API.
Paggo API es una API RESTful que permite a los desarrolladores integrar sus aplicaciones con Paggo. Para utilizar la API de paggo, los desarrolladores deben tener una cuenta en Paggo y generar una API KEY en la sección de credenciales.
La API hace uso de Autorización mediante API KEY. Esta key puede ser enviada como un Header o como un Query Parameter.
BASE URL: https://api.paggoapp.com/api
curl --location --request POST https://api.paggoapp.com/api/center/transactions/welcome' --header 'X-API-KEY:*******'
Este endpoint permite comprobar la validez de las credenciales generadas en el apartado de credenciales.
/api/center/transactions/welcome
curl --location --request POST 'https://api.paggoapp.com/api/center/transactions/welcome' --header 'X-API-KEY: ••••••'
La solicitud se ha completado con éxito.
{
"transactionId": "0d527c09-109b-43eb-bbe8-60812ae4a759",
"message": "Welcome to Paggo's API, you can now transact with us",
"result": "null"
}
Se intenta enviar una solicitud sin la cabecera X-API-KEY
{
"transactionId": "7115d1cc-f459-4312-baf6-06100ff7e3d1",
"name": "APIKEY_NOT_FOUND",
"error": "Api key not found!"
}
La solicitud se realiza con una API no válida, vencida o revocada.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "INVALID_APIKEY",
"error": "Invalid or inactive api key!"
}
Generación de link de cobro a partir de un monto fijo. El link tiene una vigencia de 3 días a partir de su fecha de generación. El link es enviado al correo electrónico proporcionado como parte del cuerpo de la solicitud.
/api/center/transactions/create-link
curl --location 'https://api.paggoapp.com/api/center/transactions/create-link' --header 'Content-Type: application/json' --header 'X-API-KEY: ••••••' --data-raw '{"concept": "Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit...", "amount": 99999, "customerName": "Bryan Solares", "email": "bsolares@paggoapp.com"}'
La solicitud se ha completado con éxito.
{
"message": "",
"result": {
"link": "https://url/PayWithLinkPayfac/EYVDVNBDWP",
"expirationDate": "2024-12-20T13:38:03-06:00"
}
}
Se intenta enviar una solicitud sin la cabecera X-API-KEY
{
"transactionId": "7115d1cc-f459-4312-baf6-06100ff7e3d1",
"name": "APIKEY_NOT_FOUND",
"error": "Api key not found!"
}
La solicitud se realiza con una API no válida, vencida o revocada.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "INVALID_APIKEY",
"error": "Invalid or inactive api key!"
}
Puedes consultar el listado de links generados con la API. Te permitirá mantener el controla de los links y sus respectivos estados.
/api/center/transactions/links
curl --location 'https://api.paggoapp.com/api/center/transactions/links' --header 'X-API-KEY: ••••••'
{
"message": "",
"resul": [
{
"id": 101912,
"nombre": "Testmetamap1",
"status": "pendiente",
"fecha": "2024-12-18T21:24:11.000Z",
"fechaVencimiento": "2024-12-20T21:24:11.000Z",
"fechaRealizoPago": null,
"monto": "100.00",
"link": "https://url/PayWithLinkPayfac/OFBYGNWKGQ"
},
{
"id": 101911,
"nombre": "Testmetamap1",
"status": "pendiente",
"fecha": "2024-12-18T19:44:26.000Z",
"fechaVencimiento": "2024-12-20T19:44:26.000Z",
"fechaRealizoPago": null,
"monto": "200.50",
"link": "https://url/PayWithLinkPayfac/ENTXHSWKDX"
}
]
}
Se intenta enviar una solicitud sin la cabecera X-API-KEY
{
"transactionId": "7115d1cc-f459-4312-baf6-06100ff7e3d1",
"name": "APIKEY_NOT_FOUND",
"error": "Api key not found!"
}
La solicitud se realiza con una API no válida, vencida o revocada.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "INVALID_APIKEY",
"error": "Invalid or inactive api key!"
}
Puedes consultar el listado de links generados con la API. Te permitirá mantener el controla de los links y sus respectivos estados.Obtienes un link a partir de un identificador único. Este identificador es generado por la API al momento de crear un link.
/api/center/transactions/links/:linkId
curl --location 'https://api.paggoapp.com/api/center/transactions/links/111111' --header 'X-API-KEY: ••••••'
La solicitud se ha completado con éxito.
{
"message": "",
"result": {
"id": 101868,
"name": "Servicio Técnico Automotriz IGM",
"status": "pagado",
"date": "2024-12-13T18:48:50.000Z",
"expirationDate": "2024-12-15T18:48:50.000Z",
"paymentDate": "2024-12-13T19:06:33.000Z",
"amount": "20.00",
"link": "https://url/PayWithLinkPayfac/QTYOHQXEOE"
}
}
Se intenta enviar una solicitud sin la cabecera X-API-KEY
{
"transactionId": "7115d1cc-f459-4312-baf6-06100ff7e3d1",
"name": "APIKEY_NOT_FOUND",
"error": "Api key not found!"
}
La solicitud se realiza con una API no válida, vencida o revocada.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "INVALID_APIKEY",
"error": "Invalid or inactive api key!"
}
El identificador proporcionado no corresponde a un link existente.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "LINK_NOT_FOUND",
"error": "Link not found!"
}
Si un link ha sido pagado exitosamente podrás obtener la dirección de descarga del voucher. (solo para links pagados).
/api/center/transactions/links/:linkId/voucher
curl --location 'https://api.paggoapp.com/api/center/transactions/links/101959/voucher' --header 'X-API-KEY: ••••••'
La solicitud se ha completado con éxito.
{
"message": "",
"result": {
"url": "https://paggo-staging-bucket.s3.us-east-2.amazonaws.com/vouchers/e84015ac-e319-46a3-a7f9-ad7a33344a18.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIARVDTB3K6HVCDDLML%2F20241218%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20241218T220417Z&X-Amz-Expires=300&X-Amz-Signature=9a7ce78e785c2dd426fb34f02ac33eaa290dc08da1c00f4ddd2c3db9e01a7211&X-Amz-SignedHeaders=host",
"expiresAt": "2024-12-18T16:09:17-06:00"
}
}
El link no ha sido pagado, por lo que no se puede generar un voucher.
{
"transactionId": "627bd7d0-3ca6-4d58-bced-83a9b35289fa",
"name": "LINK_CURRENT_STATUS",
"error": "Link not paid!"
}
El link ha sido cancelado, por lo que no se puede generar un voucher.
{
"transactionId": "20ce653a-b5a2-4c1d-b969-cbb1e0df73b7",
"name": "LINK_CURRENT_STATUS",
"error": "Link has been canceled!"
}
Se intenta enviar una solicitud sin la cabecera X-API-KEY
{
"transactionId": "7115d1cc-f459-4312-baf6-06100ff7e3d1",
"name": "APIKEY_NOT_FOUND",
"error": "Api key not found!"
}
La solicitud se realiza con una API no válida, vencida o revocada.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "INVALID_APIKEY",
"error": "Invalid or inactive api key!"
}
El identificador proporcionado no corresponde a un link existente.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "LINK_NOT_FOUND",
"error": "Link not found!"
}
Cuando haz generado un link exitosamente, tienes la posibilidad de cancelar ese link. Proporcionando el identificador del link se cancelará el link generado siempre y cuando este en estado 'PENDIENTE'
/api/center/transactions/links/:linkId/cancel
curl --location --request POST 'https://api.paggoapp.com/api/center/transactions/links/111111/cancel' --header 'X-API-KEY: ••••••'
La solicitud se ha completado con éxito.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"message": "Link successfully cancelled",
"result": null
}
El link ha sido cancelado, por lo que no se puede generar un voucher.
{
"transactionId": "20ce653a-b5a2-4c1d-b969-cbb1e0df73b7",
"name": "LINK_CURRENT_STATUS",
"error": "Link has been canceled!"
}
El link ha sido pagado, por lo que no se puede cancelar.
{
"transactionId": "caa8031b-d912-4845-94b2-a6cd55dfa1ee",
"name": "LINK_CURRENT_STATUS",
"error": "Link has been paid!"
}
Se intenta enviar una solicitud sin la cabecera X-API-KEY
{
"transactionId": "7115d1cc-f459-4312-baf6-06100ff7e3d1",
"name": "APIKEY_NOT_FOUND",
"error": "Api key not found!"
}
La solicitud se realiza con una API no válida, vencida o revocada.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "INVALID_APIKEY",
"error": "Invalid or inactive api key!"
}
El identificador proporcionado no corresponde a un link existente.
{
"transactionId": "e4a11c51-d45b-4719-9e4b-98bd877f9801",
"name": "LINK_NOT_FOUND",
"error": "Link not found!"
}
