Saltar al contenido

API Reference (1.0)

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.
Descargar descripción de OpenAPI
index.json
index.yaml
Resumen
Idiomas
Servidores
v1

https://api.zrupay.com/v1/

Transaction

Operaciones

Subscription

Operaciones

Authorization

Operaciones

Listar Autorizaciones

Solicitud

Devuelve todas las autorizaciones creadas en el entorno.

Seguridad
AppKeys
curl -i -X GET \
  https://api.zrupay.com/v1/authorization/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respuestas

OK

Cuerpoapplication/json
countnumber

Cantidad de elementos

items_per_pagenumber

Cantidad de elementos por página

nextstring or null

URL a próxima página

previousstring or null

URL a página anterior

Respuesta
application/json
[
  {
    "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"
  }
]

Crear Autorización

Solicitud

Crea una autorización en el entorno.

Seguridad
AppKeys
Cuerpoapplication/json
order_idstring

Identificador externo

currencystring= 3 charactersrequerido

Moneda en formato ISO

notestring

Nota

extraobject

Valores extra en formato JSON

return_urlstring(uri)

URL de retorno. Se envía al cliente a esta url después de realizar el pago correctamente

cancel_urlstring(uri)

URL de cancelación. Se envía al cliente a esta url si cancela el pago

notify_urlstring(uri)

URL de notificación. Se envían a esta url las notificaciones de cambio de estado

gateway_selectedboolean

Si cuando el cliente abra la pantalla de pago la primera opción debe estar seleccionada

languagestring

Idioma de la pantalla de pago

Enumeración"au""es""en""fr"
expired_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración (por defecto, es una semana después de la creación)

total_pricenumber

Cantidad a cobrar al autorizar (opcional, por defecto: 0)

authorizeboolean

Si se hace una retención o no (por defecto: false)

Predeterminado false
curl -i -X POST \
  https://api.zrupay.com/v1/authorization/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "EUR",
    "order_id": "MERCHANT_ORDER_ID",
    "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"
    }
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

tokenstring

Token de transacción. Se utiliza para representar la transacción de cara al usuario

statusstring

Estado de la transacción (N - Pendiente, C - Cancelada, D - Completada, E - Expirada)

Enumeración"N""C""D""E"
items_pricenumber(float)

Precio total de todos los productos

total_pricenumber(float)

Precio a pagar

order_idstring

Identificador externo

currencystring= 3 charactersrequerido

Moneda en formato ISO

notestring

Nota

extraobject

Valores extra en formato JSON

return_urlstring(uri)

URL de retorno. Se envía al cliente a esta url después de realizar el pago correctamente

cancel_urlstring(uri)

URL de cancelación. Se envía al cliente a esta url si cancela el pago

notify_urlstring(uri)

URL de notificación. Se envían a esta url las notificaciones de cambio de estado

gateway_selectedboolean

Si cuando el cliente abra la pantalla de pago la primera opción debe estar seleccionada

languagestring

Idioma de la pantalla de pago

Enumeración"au""es""en""fr"
expired_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración (por defecto, es una semana después de la creación)

Respuesta
application/json
{
  "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"
}

Obtener Autorización

Solicitud

Devuelve la autorización solicitada.

Seguridad
AppKeys
Ruta
authorization-idstring(uuid)requerido

Identificador de la autorización que se desea solicitar

curl -i -X GET \
  'https://api.zrupay.com/v1/authorization/{authorization-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

tokenstring

Token de transacción. Se utiliza para representar la transacción de cara al usuario

statusstring

Estado de la transacción (N - Pendiente, C - Cancelada, D - Completada, E - Expirada)

Enumeración"N""C""D""E"
items_pricenumber(float)

Precio total de todos los productos

total_pricenumber(float)

Precio a pagar

order_idstring

Identificador externo

currencystring= 3 charactersrequerido

Moneda en formato ISO

notestring

Nota

extraobject

Valores extra en formato JSON

return_urlstring(uri)

URL de retorno. Se envía al cliente a esta url después de realizar el pago correctamente

cancel_urlstring(uri)

URL de cancelación. Se envía al cliente a esta url si cancela el pago

notify_urlstring(uri)

URL de notificación. Se envían a esta url las notificaciones de cambio de estado

gateway_selectedboolean

Si cuando el cliente abra la pantalla de pago la primera opción debe estar seleccionada

languagestring

Idioma de la pantalla de pago

Enumeración"au""es""en""fr"
expired_datestring(date-time)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de expiración (por defecto, es una semana después de la creación)

Respuesta
application/json
{
  "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"
}

Cobrar una Autorización

Solicitud

Realiza un cobro utilizando el método de pago autorizado.

Seguridad
AppKeys
Ruta
authorization-idstring(uuid)requerido

Identificador de la autorización que se desea cobrar

Cuerpoapplication/json
amountnumber(float)

Cantidad (en el caso de que no se envie se asume el total)

extraobject

Valores extras en formato JSON

charge_idstring

Identificador externo

authorizeboolean

Si se hace una retención o no (por defecto: false)

destinationArray of objects or null(destination.v1)

Destino de los fondos

curl -i -X POST \
  'https://api.zrupay.com/v1/authorization/{authorization-id}/charge/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 21.12,
    "charge_id": "MERCHANT_CHARGE_ID"
  }'

Respuestas

OK

Cuerpoapplication/json
successboolean

Resultado de la operación

responsestring

Mensaje de error en caso de fallo

Respuesta
application/json
{
  "success": true,
  "response": "string"
}

Eliminar una Autorización

Solicitud

Elimina una autorización, después de realizar esta acción no se podrá utilizar de nuevo.

Seguridad
AppKeys
Ruta
authorization-idstring(uuid)requerido

Identificador de la autorización que se desea eliminar

curl -i -X POST \
  'https://api.zrupay.com/v1/authorization/{authorization-id}/remove/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respuestas

OK

Cuerpoapplication/json
successboolean

Resultado de la operación

responsestring

Mensaje de error en caso de fallo

Respuesta
application/json
{
  "success": true,
  "response": "string"
}

Sale

Operaciones

Product

Operaciones

Plan

Operaciones

Tax

Operaciones

Shipping

Operaciones

Coupon

Operaciones

Client

Operaciones

Wallet

Operaciones

Transfer

Operaciones

Gateway

Operaciones

Currency

Currency

Operaciones