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

Sale

Operaciones

Listar Pagos

Solicitud

Devuelve todos los pagos creados en el entorno.

Seguridad
AppKeys
curl -i -X GET \
  https://api.zrupay.com/v1/sale/ \
  -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

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

Obtener Pago

Solicitud

Devuelve el pago solicitado.

Seguridad
AppKeys
Ruta
sale-idstring(uuid)requerido

Identificador del pago que se desea solicitar

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

transaction_idstring(uuid)

Identificador de la transacción a la que pertenece

amountnumber(float)

Valor total del pago

amount_capturenumber(float)

Cantidad del valor total del pago que esta capturada

holdboolean

Si el pago está en espera

partial_holdboolean

Si el pago está parcialmente en espera

hold_amountnumber(float)

Cantidad del valor total del pago en espera

refundboolean

Si el pago ha sido devuelto

partial_refundboolean

Si el pago ha sido parcialmente devuelto

refund_amountnumber(float)

Cantidad del valor total del pago devuelto

payment_maskedstring

Texto que representa el método de pago utilizado (ejemplo: en el caso de tarjeta los últimos cuatro dígitos)

created_datestring(date)YYYY-MM-DDThh:mm[:ss[.uuuuuu]][+HH:MM|-HH:MM|...

Fecha de creación del pago

sourceArray of objects or null(source.v1)

Origen de los fondos

destinationArray of objects or null(destination.v1)

Destino de los fondos

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
  "amount": 0.1,
  "amount_capture": 0.1,
  "hold": true,
  "partial_hold": true,
  "hold_amount": 0.1,
  "refund": true,
  "partial_refund": true,
  "refund_amount": 0.1,
  "payment_masked": "string",
  "created_date": "2019-08-24",
  "source": [
    { … }
  ],
  "destination": [
    { … }
  ]
}

Capturar Pago

Solicitud

Captura la parte del pago en espera, total o parcialmente.

Seguridad
AppKeys
Ruta
sale-idstring(uuid)requerido

Identificador del pago que se desea solicitar

Cuerpoapplication/json
amountnumber(float)

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

extraobject

Valores extras en formato JSON

destinationArray of objects or null(destination.v1)

Destino de los fondos

curl -i -X POST \
  'https://api.zrupay.com/v1/sale/{sale-id}/capture/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{}'

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"
}

Devolver Pago

Solicitud

Devuelve la parte del pago capturada, total o parcialmente.

Seguridad
AppKeys
Ruta
sale-idstring(uuid)requerido

Identificador del pago que se desea solicitar

Cuerpoapplication/json
amountnumber(float)

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

extraobject

Valores extras en formato JSON

destinationArray of objects or null(destination.v1)

Destino de los fondos

curl -i -X POST \
  'https://api.zrupay.com/v1/sale/{sale-id}/refund/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{}'

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"
}

Liberar Pago

Solicitud

Libera la parte del pago en espera, total o parcialmente.

Seguridad
AppKeys
Ruta
sale-idstringrequerido

Identificador del pago que se desea solicitar

Cuerpoapplication/json
amountnumber(float)

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

extraobject

Valores extras en formato JSON

destinationArray of objects or null(destination.v1)

Destino de los fondos

curl -i -X POST \
  'https://api.zrupay.com/v1/sale/{sale-id}/void/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{}'

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"
}

Product

Operaciones

Plan

Operaciones

Tax

Operaciones

Shipping

Operaciones

Coupon

Operaciones

Client

Operaciones

Wallet

Operaciones

Transfer

Operaciones

Gateway

Operaciones

Currency

Currency

Operaciones