El API de ZRU utiliza métodos HTTP y una estructura RESTful de endpoint.
- La autenticación del API se realiza vía Header Authorization.
- Todas las peticiones se deben realizar en formato JSON, y las respuestas del API son en dicho formato.
El API de ZRU utiliza métodos HTTP y una estructura RESTful de endpoint.
curl -i -X GET \
https://api.zrupay.com/v1/subscription/ \
-H 'Authorization: YOUR_API_KEY_HERE'{ "count": 0, "items_per_page": 0, "next": "string", "previous": "string", "results": [ { … } ] }
URL de retorno. Se envía al cliente a esta url después de realizar el pago correctamente
URL de notificación. Se envían a esta url las notificaciones de cambio de estado
Si cuando el cliente abra la pantalla de pago la primera opción debe estar seleccionada
Fecha de expiración (por defecto, es una semana después de la creación)
Identificador del plan al que se suscribe al usuario existente en el API (requerido si no se envía el parámetro plan)
Precio a pagar en un primer periodo de prueba (si se envía se deben enviar también los parámetros duration1 y unit1)
Unidad de tiempo del primer periodo de prueba (opciones: D - Día, M - Mes, Y - Año)
curl -i -X POST \
https://api.zrupay.com/v1/subscription/ \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"currency": "EUR",
"order_id": "MERCHANT_ORDER_ID",
"plan": {
"name": "PLAN_NAME",
"duration": 1,
"unit": "M",
"price": 5.25
},
"return_url": "https://www.merchant.com/return",
"cancel_url": "https://www.merchant.com/cancel",
"notify_url": "https://www.merchant.com/notify",
"extra": {
"email": "client@email.com",
"first_name": "CLIENT_FIRST_NAME",
"last_name": "CLIENT_LAST_NAME",
"MERCHANT_KEY_1": "MERCHANT_VALUE_1",
"MERCHANT_KEY_2": "MERCHANT_VALUE_2"
}
}'Created
Estado de la transacción (N - Pendiente, C - Cancelada, D - Completada, E - Expirada)
URL de retorno. Se envía al cliente a esta url después de realizar el pago correctamente
URL de notificación. Se envían a esta url las notificaciones de cambio de estado
Si cuando el cliente abra la pantalla de pago la primera opción debe estar seleccionada
Fecha de expiración (por defecto, es una semana después de la creación)
Identificador del plan al que se suscribe al usuario existente en el API (requerido si no se envía el parámetro plan)
Precio a pagar en un primer periodo de prueba (si se envía se deben enviar también los parámetros duration1 y unit1)
Unidad de tiempo del primer periodo de prueba (opciones: D - Día, M - Mes, Y - Año)
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "token": "string", "status": "N", "items_price": 0.1, "total_price": 0.1, "order_id": "string", "currency": "str", "note": "string", "extra": {}, "return_url": "http://example.com", "cancel_url": "http://example.com", "notify_url": "http://example.com", "gateway_selected": true, "language": "au", "expired_date": "2019-08-24T14:15:22Z", "plan_id": "00713021-9aea-41da-9a88-87760c08fa72", "plan": { "plan_id": "string", "name": "string", "price": 0.1, "description": "string", "duration": 0, "unit": "D", "recurring": true }, "trial_price1": 0.1, "duration1": 0, "unit1": "D", "source": [ { … } ], "destination": [ { … } ] }
curl -i -X GET \
'https://api.zrupay.com/v1/subscription/{subscription-id}/' \
-H 'Authorization: YOUR_API_KEY_HERE'OK
Estado de la transacción (N - Pendiente, C - Cancelada, D - Completada, E - Expirada)
URL de retorno. Se envía al cliente a esta url después de realizar el pago correctamente
URL de notificación. Se envían a esta url las notificaciones de cambio de estado
Si cuando el cliente abra la pantalla de pago la primera opción debe estar seleccionada
Fecha de expiración (por defecto, es una semana después de la creación)
Identificador del plan al que se suscribe al usuario existente en el API (requerido si no se envía el parámetro plan)
Precio a pagar en un primer periodo de prueba (si se envía se deben enviar también los parámetros duration1 y unit1)
Unidad de tiempo del primer periodo de prueba (opciones: D - Día, M - Mes, Y - Año)
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "token": "string", "status": "N", "items_price": 0.1, "total_price": 0.1, "order_id": "string", "currency": "str", "note": "string", "extra": {}, "return_url": "http://example.com", "cancel_url": "http://example.com", "notify_url": "http://example.com", "gateway_selected": true, "language": "au", "expired_date": "2019-08-24T14:15:22Z", "plan_id": "00713021-9aea-41da-9a88-87760c08fa72", "plan": { "plan_id": "string", "name": "string", "price": 0.1, "description": "string", "duration": 0, "unit": "D", "recurring": true }, "trial_price1": 0.1, "duration1": 0, "unit1": "D", "source": [ { … } ], "destination": [ { … } ] }
curl -i -X POST \
'https://api.zrupay.com/v1/subscription/{subscription-id}/start/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "success": true, "response": "string" }
curl -i -X POST \
'https://api.zrupay.com/v1/subscription/{subscription-id}/pause/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "success": true, "response": "string" }
curl -i -X POST \
'https://api.zrupay.com/v1/subscription/{subscription-id}/active/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "success": true, "response": "string" }
curl -i -X POST \
'https://api.zrupay.com/v1/subscription/{subscription-id}/stop/' \
-H 'Authorization: YOUR_API_KEY_HERE'{ "success": true, "response": "string" }