Documentación
WSPG - Web Service Pagadito
Pagadito ofrece el WSPG, un web service al que los Pagadito Comercios podrán consumir desde sus plataformas y utilizar como medio de cobros.
Pagadito le permite a los Pagadito Comercios realizar cobros de forma rápida y segura, a través de su plataforma de pagos. La tecnología desarrollada en Pagadito, permite la comunicación con múltiples plataformas de forma síncrona, mediante conexiones seguras, únicas y autorizadas.
1. Conexión
El mecanismo de comunicación
funciona de forma que el Pagadito Comercio se conecta al web service WSPG
y éste a su vez con Pagadito. El WSPG funciona como interlocutor entre sistemas.
El encargado de realizar las transacciones es Pagadito, de ésta forma se aseguran
los datos tanto del usuario comprador como del Pagadito Comercio. Una vez finalizado el cobro,
se retorna el control al Pagadito Comercio.
Al realizar pruebas en el SandBox,
los Desarrolladores deben conectarse al WSPG, apuntando a la URL de Conexión
https://sandbox.pagadito.com/comercios/wspg/charges.php
Los Pagadito Comercios en fase de producción, tienen que conectarse al WSPG, apuntando
a la URL de Conexión
https://comercios.pagadito.com/wspg/charges.php
Inicio
2. Respuestas del WSPG
Todas las operaciones retornan los datos en una estructura definida a continuación en formato codificado y definido en las peticiones:
2.1 Estructura de respuesta
Para una petición en formato JSON se presenta así:
{"code":"PG1001","message":"Connection successful.","value":"5140aebdd0dddf14795c7d69438f2aac"}
Luego de decodificarla se presenta así:
stdClass Object
(
[code] => PG1001
[message] => Connection successful.
[value] => 5140aebdd0dddf14795c7d69438f2aac
[datetime] => 2011-11-08 12:01:56
)
Para una petición en formato PHP se presenta así:
O:8:"stdClass":4:{s:4:"code";s:6:"PG1001";s:7:"message";s:22:"Connection successful.";s:5:"value";s:32:"5140aebdd0dddf14795c7d69438f2aac";s:6:";}
Luego de decodificarla se presenta así:
stdClass Object
(
[code] => PG1001
[message] => Connection successful.
[value] => 5140aebdd0dddf14795c7d69438f2aac
[datetime] => 2011-11-08 12:01:56
)
Para una petición en formato XML se presenta así:
<response>
<code>PG1001</code>
<message>Connection successful.</message>
<value>5140aebdd0dddf14795c7d69438f2aac</value>
<value>2011-11-08 12:01:56</value>
</response>
En el índice "code" se devuelve un código único que identifica
el tipo respuesta del WSPG. En el índice "message" se devuelve un mensaje
descriptivo de la respuesta. En el índice "value" se devuelve un valor
cuando el tipo de respuesta lo requiere. En el índice "datetime" se
devuelve la fecha y hora en la que el WSPG responde.
2.2 Listado de Respuestas
Inicio
3. Operaciones
El WSPG contiene las siguientes operaciones:
3.1 connect(uid, wsk [, format_return])
Descripción
Devuelve el token de conexión en caso de una validación satisfactoria de las credenciales UID y WSK enviadas.
Parámetros
- uid
- El identificador del Pagadito Comercio.
- wsk
- La clave de acceso.
- format_return
-
El formato en que se devolverán los datos.
- json
- Valor por defecto. Estructura codificada en formato JSON.
- php
- Estructura serializada.
- xml
- Estructura en XML.
Valores devueltos
Devuelve una cadena que contiene la estructura en el formato definido en el
parámetro format_return. En caso de éxito, el WSPG devuelve un
código de mensaje PG1001 y el token se encuentra
en el índice "value" de la estructura devuelta. De lo contrario, el
código de mensaje devuelto puede ser: PG2001,
PG3001, PG3002 o
PG3005.
Para ver el listado completo de códigos, mensajes y descripciones de las
respuestas del WSPG, ir a Listado de Respuestas.
Detalles
- Name: connect
- Binding: wspgBinding
- Endpoint: https://comercios.pagadito.com/wspg/charges.php
- SoapAction: urn:ws#connect
- Style: rpc
- Input:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: connectRequest
-
- parts:
- uid: xsd:string
- wsk: xsd:string
- format_return: xsd:string
- Output:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: connectResponse
-
- parts:
- return: xsd:string
- Namespace: urn:wspg
- Transport: http://schemas.xmlsoap.org/soap/http
- Documentation: Validate affiliated trade
3.2 exec_trans(token, ern, amount, details [, format_return, currency, custom_params])
Descripción
Devuelve la url a la que debe redireccionar el Pagadito Comercio, luego de procesar satisfactoriamente la transacción solicitada, en base a los parámetros enviados, para que Pagadito realice el cobro al usuario comprador.
Parámetros
- token
- El identificador de la conexión establecida entre el Pagadito Comercio y el WSPG.
- ern (External Reference Number)
- Es un número único y obligatorio que identifica una transacción, provisto por el Pagadito Comercio y se utiliza para rastrear las transacciones realizadas por éste.
- amount
- Es el monto total de la trasacción, en términos de dólares americanos (USD).
- details
-
Es una estructura que contiene los detalles de la compra, definida como un
arreglo de arreglos. Su formato dependerá del formato definido en format_return.
Cada detalle está definido en un arreglo con los siguientes índices:
- quantity
- Define la cantidad del producto.
- description
- Define la descripción del producto.
- price
- Define el precio del producto en términos de dólares americanos (USD).
- url_product
- Define la url de referencia del producto.
La definición completa de la estructura para el parámetro "details" quedaría de la siguiente manera:
Array ( [0] => Array ( [quantity] => 2 [description] => Producto X [price] => 1.5 [url_product] => http://www.misitio.com/ver.php?id=12 ) [1] => Array ( [quantity] => 4 [description] => Producto Y [price] => 4 [url_product] => http://www.misitio.com/ver.php?id=34 ) [2] => Array ( [quantity] => 3 [description] => Producto Z [price] => 0.75 [url_product] => http://www.misitio.com/ver.php?id=67 ) )
[{"quantity":2,"description":"Producto X","price":1.5,"url_product":"http:\/\/www.misitio.com\/ver.php?id=12"},{"quantity":4,"description":"Producto Y","price":4,"url_product":"http:\/\/www.misitio.com\/ver.php?id=34"},{"quantity":3,"description":"Producto Z","price":0.75,"url_product":"http:\/\/www.misitio.com\/ver.php?id=67"}]
Para una petición en formato PHP (serializada) se presenta así:
a:3:{i:0;a:4:{s:8:"quantity";i:2;s:11:"description";s:10:"Producto X";s:5:"price";d:1.5;s:11:"url_product";s:36:"http://www.misitio.com/ver.php?id=12";}i:1;a:4:{s:8:"quantity";i:4;s:11:"description";s:10:"Producto Y";s:5:"price";d:4;s:11:"url_product";s:36:"http://www.misitio.com/ver.php?id=34";}i:2;a:4:{s:8:"quantity";i:3;s:11:"description";s:10:"Producto Z";s:5:"price";d:0.75;s:11:"url_product";s:36:"http://www.misitio.com/ver.php?id=67";}}
Para una petición en formato XML se presenta así:<details> <detail> <quantity>2</quantity> <description>Producto X</description> <price>1.50</price> <url_product>http://www.misitio.com/ver.php?id=12</url_product> </detail> <detail> <quantity>4</quantity> <description>Producto Y</description> <price>4.00</price> <url_product>http://www.misitio.com/ver.php?id=34</url_product> </detail> <detail> <quantity>3</quantity> <description>Producto Z</description> <price>0.75</price> <url_product>http://www.misitio.com/ver.php?id=67</url_product> </detail> </details> - format_return
-
El formato en que se devolverán los datos.
- json
- Valor por defecto. Estructura codificada en formato JSON.
- php
- Estructura serializada.
- xml
- Estructura en XML.
- currency
-
Es la moneda en la que se están enviando los valores.
- USD
- Valor por defecto. Dólares americanos.
- GTQ
- Quetzales.
- HNL
- Lempiras.
- NIO
- Córdobas.
- CRC
- Colones costarricenses.
- PAB
- Balboas.
- DOP
- Pesos dominicanos.
- custom_params
-
Es una estructura que contiene el valor de los parámetros personalizados establecidos
por el Pagadito Comercio, definida como un arreglo asociativo de elementos. Su formato
dependerá del formato definido en format_return.
La definición completa de la estructura para el parámetro "custom_params" quedaría de la siguiente manera:
Array ( [param1] => Valor del parámetro 1 [param2] => Valor del parámetro 2 [param3] => Valor del parámetro 3 [param4] => Valor del parámetro 4 [param5] => Valor del parámetro 5 )
{"param1":"Valor del parámetro 1","param2":"Valor del parámetro 2","param3":"Valor del parámetro 3","param4":"Valor del parámetro 4","param5":"Valor del parámetro 5"}
Para una petición en formato PHP (serializada) se presenta así:
a:5:{s:6:"param1";s:28:"Valor del parámetro 1";s:6:"param2";s:28:"Valor del parámetro 2";s:6:"param3";s:28:"Valor del parámetro 3";s:6:"param4";s:28:"Valor del parámetro 4";s:6:"param5";s:28:"Valor del parámetro 5";}
Para una petición en formato XML se presenta así:<custom_params> <param1>Valor del parámetro 1</param1> <param2>Valor del parámetro 2</param2> <param3>Valor del parámetro 3</param3> <param4>Valor del parámetro 4</param4> <param5>Valor del parámetro 5</param5> </custom_params>
Valores devueltos
Devuelve una cadena que contiene la estructura en el formato definido en el
parámetro format_return. En caso de éxito, el WSPG devuelve un
código de mensaje PG1002 y la url se encuentra
en el índice "value" de la estructura devuelta. De lo contrario, el
código de mensaje devuelto puede ser: PG2001,
PG2002,
PG3002, PG3003,
PG3004, PG3006,
PG3007 o PG3008.
Para ver el listado completo de códigos, mensajes y descripciones de las
respuestas del WSPG, ir a Listado de Respuestas.
Detalles
- Name: exec_trans
- Binding: wspgBinding
- Endpoint: https://comercios.pagadito.com/wspg/charges.php
- SoapAction: urn:ws#exec_trans
- Style: rpc
- Input:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: connectRequest
-
- parts:
- token: xsd:string
- ern: xsd:string
- amount: xsd:string
- details: xsd:string
- format_return: xsd:string
- custom_params: xsd:string
- Output:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: connectResponse
-
- parts:
- return: xsd:string
- Namespace: urn:wspg
- Transport: http://schemas.xmlsoap.org/soap/http
- Documentation: Register transaction
3.3 get_status(token, token_trans [, format_return])
Descripción
Devuelve el estado en el que se encuentra la transacción identificada por el token_trans. En caso de estar finalizada, además del estado se devuelve el ID de la transacción.
Parámetros
- token
- El identificador de la conexión establecida entre el Pagadito Comercio y el WSPG.
- token_trans
- El identificador de la conexión a consultar.
- format_return
-
El formato en que se devolverán los datos.
- json
- Valor por defecto. Estructura codificada en formato JSON.
- php
- Estructura serializada.
- xml
- Estructura en XML.
Valores devueltos
Devuelve una cadena que contiene la estructura en el formato definido en el
parámetro format_return. En caso de éxito, el WSPG devuelve un
código de mensaje PG1003 y en el índice
"value" retorna la siguiente estructura:
Para una petición en formato JSON se presenta así:
stdClass Object
(
[status] => COMPLETED
[reference] => 7DFC8A49F5B87B8734F9E28B08456002
[date_trans] => 2011-11-08 12:03:11
)
Para una petición en formato PHP se presenta así:
Array
(
[status] => COMPLETED
[reference] => 7DFC8A49F5B87B8734F9E28B08456002
[date_trans] => 2011-11-08 12:03:11
)
Para una petición en formato XML se presenta así:
<status>COMPLETED</status>
<reference>7DFC8A49F5B87B8734F9E28B08456002</reference>
<date_trans>2011-11-08 12:03:11</date_trans>
El estado de la transacción se encuentra en el índice
"status". Este puede ser:
| status | reference | date_trans | Descripción |
|---|---|---|---|
| REGISTERED | La transacción ha sido registrada correctamente en Pagadito, pero aún se encuentra en proceso. En este punto, el cobro aún no ha sido realizado. | ||
| COMPLETED | X | X | La transacción ha sido procesada correctamente en Pagadito. En este punto el cobro ya ha sido realizado. |
| VERIFYING | X | X | La transacción ha sido procesada en Pagadito, pero ha quedado en verificación. En este punto el cobro ha quedado en validación administrativa. Posteriormente, la transacción puede marcarse como válida o denegada; por lo que se debe monitorear mediante esta función hasta que su estado cambie a COMPLETED o REVOKED. |
| REVOKED | X | X | La transacción en estado VERIFYING ha sido denegada por Pagadito. En este punto el cobro ya ha sido cancelado. |
| FAILED | La transacción ha sido registrada correctamente en Pagadito, pero no pudo ser procesada. En este punto, el cobro aún no ha sido realizado. | ||
| CANCELED | La transacción ha sido cancelada por el usuario en Pagadito, la transacción tiene este estado cuando el usuario hace click en el enlace de "regresar al comercio" en la pantalla de pago de Pagadito. | ||
| EXPIRED | La transacción ha expirado en Pagadito, la transacción tiene este estado cuando se termina el tiempo para completar la transacción por parte del usuario en Pagadito, el tiempo para completar la transacción en Pagadito por parte del usuario es de 10 minutos. Pagadito también se encarga de poner estado EXPIRED a todas las transacciones que no fueron completas, debido a que el usuario salio de manera inesperada del proceso de pago, por ejemplo cerrando la ventana del navegador. |
En caso de estar en estado "COMPLETED" (finalizada), la referencia de la transacción se encuentra en el índice "reference" y la fecha y hora en que se procesó en el índice "date_trans".
En caso de no procesarse exitosamente la petición, el código de mensaje devuelto puede ser: PG2001, PG3002, PG3003 o PG3007.
Para ver el listado completo de códigos, mensajes y descripciones de las respuestas del WSPG, ir a Listado de Respuestas.
Detalles
- Name: get_status
- Binding: wspgBinding
- Endpoint: https://comercios.pagadito.com/wspg/charges.php
- SoapAction: urn:ws#get_status
- Style: rpc
- Input:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: connectRequest
-
- parts:
- token: xsd:string
- token_trans: xsd:string
- format_return: xsd:string
- Output:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: connectResponse
-
- parts:
- return: xsd:string
- Namespace: urn:wspg
- Transport: http://schemas.xmlsoap.org/soap/http
- Documentation: Consults the status of a transaction
3.4 get_exchange_rate(token, currency [, format_return])
Descripción
Devuelve la tasa de cambio de la moneda solicitada.
Parámetros
- token
- El identificador de la conexión establecida entre el Pagadito Comercio y el WSPG.
- currency
-
Es la moneda en la que se están enviando los valores.
- USD
- Valor por defecto. Dólares americanos.
- GTQ
- Quetzales.
- HNL
- Lempiras.
- NIO
- Córdobas.
- CRC
- Colones costarricenses.
- PAB
- Balboas.
- DOP
- Pesos dominicanos.
- format_return
-
El formato en que se devolverán los datos.
- json
- Valor por defecto. Estructura codificada en formato JSON.
- php
- Estructura serializada.
- xml
- Estructura en XML.
Valores devueltos
Devuelve una cadena que contiene la estructura en el formato definido en el
parámetro format_return. En caso de éxito, el WSPG devuelve un
código de mensaje PG1004 y la tasa de cambio
se encuentra en el índice "value" de la estructura devuelta. De lo
contrario, el código de mensaje devuelto puede ser:
PG2001, PG3002,
PG3007 o PG3008.
Para ver el listado completo de códigos, mensajes y descripciones de las
respuestas del WSPG, ir a Listado de Respuestas.
Detalles
- Name: get_exchange_rate
- Binding: wspgBinding
- Endpoint: https://comercios.pagadito.com/wspg/charges.php
- SoapAction: urn:ws#get_exchange_rate
- Style: rpc
- Input:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: connectRequest
-
- parts:
- token: xsd:string
- currency: xsd:string
- format_return: xsd:string
- Output:
- use: encoded
- namespace: urn:wspg
- encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
- message: get_exchange_rateResponse
-
- parts:
- return: xsd:string
- Namespace: urn:wspg
- Transport: http://schemas.xmlsoap.org/soap/http
- Documentation: Consults the exchange rate of a currency
4. WSDL
Si su navegador no permite visualizar el siguiente iframe, haga click aquí.Inicio
