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.
Download OpenAPI description
Overview
Languages
Servers
v1
https://api.zrupay.com/v1/

Transaction

Operations

Subscription

Operations

Authorization

Operations

Sale

Operations

Product

Operations

Plan

Operations

Listar Planes

Request

Devuelve todos los planes creados en el entorno.

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

Responses

OK

Bodyapplication/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

resultsArray of objects(Plan)
Response
application/json
{ "count": 0, "items_per_page": 0, "next": "string", "previous": "string", "results": [ {} ] }

Crear Plan

Request

Crea un plan en el entorno.

Bodyapplication/json
plan_idstring

Identificador externo

namestringrequired

Nombre

pricenumber(float)required

Precio

descriptionstring

Descripción

durationintegerrequired

Duración

unitstringrequired

Unidad de tiempo de la duración (opciones: D - Día, M - Mes, Y - Año)

Enum"D""M""Y"
recurringboolean

Si es un plan recurrente o no (por defecto: True)

curl -i -X POST \
  https://api.zrupay.com/v1/plan/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "NAME",
    "price": 20,
    "duration": 2,
    "unit": "M",
    "plan_id": "MERCHANT_PLAN_ID",
    "description": "DESCRIPTION",
    "total_payments": 2,
    "extra": {
      "MERCHANT_KEY": "MERCHANT_VALUE"
    }
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

display_unitstring

Unidad de tiempo para mostrar

plan_idstring

Identificador externo

namestringrequired

Nombre

pricenumber(float)required

Precio

descriptionstring

Descripción

durationintegerrequired

Duración

unitstringrequired

Unidad de tiempo de la duración (opciones: D - Día, M - Mes, Y - Año)

Enum"D""M""Y"
recurringboolean

Si es un plan recurrente o no (por defecto: True)

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "display_unit": "string", "plan_id": "string", "name": "string", "price": 0.1, "description": "string", "duration": 0, "unit": "D", "recurring": true }

Obtener Plan

Request

Devuelve el plan solicitado.

Path
plan-idstring(uuid)required

Identificador del plan que se desea solicitar

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

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

display_unitstring

Unidad de tiempo para mostrar

plan_idstring

Identificador externo

namestringrequired

Nombre

pricenumber(float)required

Precio

descriptionstring

Descripción

durationintegerrequired

Duración

unitstringrequired

Unidad de tiempo de la duración (opciones: D - Día, M - Mes, Y - Año)

Enum"D""M""Y"
recurringboolean

Si es un plan recurrente o no (por defecto: True)

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "display_unit": "string", "plan_id": "string", "name": "string", "price": 0.1, "description": "string", "duration": 0, "unit": "D", "recurring": true }

Editar Plan

Request

Edita el plan solicitado.

Path
plan-idstring(uuid)required

Identificador del plan que se desea solicitar

Bodyapplication/json
plan_idstring

Identificador externo

namestring

Nombre

pricenumber(float)

Precio

descriptionstring

Descripción

durationinteger

Duración

unitstring

Unidad de tiempo de la duración (opciones: D - Día, M - Mes, Y - Año)

Enum"D""M""Y"
recurringboolean

Si es un plan recurrente o no (por defecto: True)

curl -i -X PATCH \
  'https://api.zrupay.com/v1/plan/{plan-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "price": 150
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

display_unitstring

Unidad de tiempo para mostrar

plan_idstring

Identificador externo

namestringrequired

Nombre

pricenumber(float)required

Precio

descriptionstring

Descripción

durationintegerrequired

Duración

unitstringrequired

Unidad de tiempo de la duración (opciones: D - Día, M - Mes, Y - Año)

Enum"D""M""Y"
recurringboolean

Si es un plan recurrente o no (por defecto: True)

Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "display_unit": "string", "plan_id": "string", "name": "string", "price": 0.1, "description": "string", "duration": 0, "unit": "D", "recurring": true }

Eliminar Plan

Request

Elimina el plan solicitado.

Path
plan-idstring(uuid)required

Identificador del plan que se desea solicitar

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

Responses

OK

Tax

Operations

Shipping

Operations

Coupon

Operations

Client

Operations

Wallet

Operations

Transfer

Operations

Gateway

Operations

Currency

Currency

Operations