Consideraciones
Para utilizar el servicio de pagos en lote se deben tomar en cuenta las siguiente consideraciones:
- Utilizar el servicio en los endpoints:
- Sandbox: https://sandbox-merchant.greenpay.me/bulk
- Producción: https://merchant.greenpay.me/bulk
- Tener tarjetas registradas (tokenizadas en Greenpay), es decir, contar con tokens de tarjetas disponibles para utilizar. Para conocer cómo crear token de tarjeta visite la sección de artículos Registro de tarjetas
- Tener una cuenta de sandbox o producción con Greenpay. Para crear una cuenta de sandbox puede registrarla en Crear cuenta sandbox y para la cuenta de producción debe haber finalizado el proceso con el equipo de afiliación de Greenpay (afiliacion@greenpay.me) y realizar una revisión técnica con el equipo de soporte de Greenpay (support@greenpay.me).
Pasos para uso del servicio
1. Estructura de los datos
Se debe crear un objeto JSON que tenga la siguiente estructura:
{
"merchantId":"your_merchant_id",
"secret":"your_secret",
"terminal":"your_terminal",
"currency":"USD || CRC || GTQ",
"payments":[
{
"orderReference":"xwr-100",
"amount":0.00,
"token":[
"the_card_token_to_use_in_your_payment"
],
"name":"Full name",
"email":"example@greenpay.me"
},
{
"orderReference":"xwr-200",
"amount":0.00,
"token":[
"the_card_token_to_use_in_your_payment"
],
"name":"Full name",
"email":"example@greenpay.me"
}
]
}
Los parámetros obligatorios para crea un pago en lote son:
- merchantId: Proporcionado por Greenpay
- secret: Proporcionado por Greenpay.
- terminal: Proporcinado por Greenpay.
- currency: Este valor debe coincidir con la moneda del terminal, es decir, si el terminal es USD entonces el parámetro currency debe ser USD.
- payments: Son los cobros que se van a realizar, puede ser uno o más objetos.
- orderReference: Identificador único de la transacción.
- amount: Monto que no debe ser 0.
- token: El token de tarjeta al que se le hará el cobro.
- name: Nombre del cliente.
- email: Correo electrónico del cliente.
2. Enviar solicitud de pagos en lote
Se debe enviar una solicitud HTTP de tipo POST al endpoint de pagos en lote con el objeto json que contiene los datos de los cobros. Una vez se procesa la solicitud con éxito, se obtiene un objeto de tipo JSON como el siguiente:
{
"status": 200,
"bulkId": "83be3d9d-8ebb-4cdf-a96a-c364da15bd80"
}

El bulkId es un identificador único asociado a los cobros.
3. Respuesta en el webhook
Para saber el resultado de cada cobro enviado en lote se debe implementar el webhook.

El webhook es un API que el comercio expone para que Greenpay envíe la respuesta de los cobros realizados.
El URL del endpoint debe ser como