Saltar al contenido
Transaction
/
Listar Transacciones

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

Listar Transacciones

Solicitud

Devuelve todas las transacciones creadas en el entorno.

Seguridad
AppKeys
curl -i -X GET \
  https://api.zrupay.com/v1/transaction/ \
  -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(transaction.v1)
Respuesta
application/json
{
  "count": 0,
  "items_per_page": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Crear Transacción

Solicitud

Crea una transacció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)

productsArray of objects(item-product.v1)non-emptyrequerido

Lista de elementos de producto

products[].​amountnumber>= 1requerido

Cantidad del producto

products[].​product_idstring(uuid)

Identificador del producto existente en el API (requerido si no se envía el parámetro product)

products[].​productobject(product-create.v1)

Representa el modelo de datos para crear un producto.

tax_valuenumber(float)

Cantidad a pagar relacionada con el impuesto

tax_namestring

Nombre del impuesto incluido en la transacción

taxstring(uuid)

Identificador de impuesto existente en el API

shipping_valuenumber(float)

Cantidad a pagar relacionada con el envío

shipping_namestring

Nombre del envío incluido en la transacción

shippingstring(uuid)

Identificador de envío existente en el API

coupon_valuenumber(float)

Cantidad a descontar relacionada con el cupón

coupon_namestring

Nombre del cupón incluido en la transacción

couponstring(uuid)

Identificador de cupón existente en el API

authorizeboolean

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

sourceArray of objects or null(source.v1)

Origen de los fondos

destinationArray of objects or null(destination.v1)

Destino de los fondos

curl -i -X POST \
  https://api.zrupay.com/v1/transaction/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "EUR",
    "order_id": "MERCHANT_ORDER_ID",
    "products": [
      {
        "amount": 1,
        "product": {
          "name": "PRODUCT_NAME",
          "price": 10.55
        }
      }
    ],
    "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

Created

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)

productsArray of objects(item-product.v1)non-emptyrequerido

Lista de elementos de producto

products[].​amountnumber>= 1requerido

Cantidad del producto

products[].​product_idstring(uuid)

Identificador del producto existente en el API (requerido si no se envía el parámetro product)

products[].​productobject(product-create.v1)

Representa el modelo de datos para crear un producto.

tax_valuenumber(float)

Cantidad a pagar relacionada con el impuesto

tax_namestring

Nombre del impuesto incluido en la transacción

taxstring(uuid)

Identificador de impuesto existente en el API

shipping_valuenumber(float)

Cantidad a pagar relacionada con el envío

shipping_namestring

Nombre del envío incluido en la transacción

shippingstring(uuid)

Identificador de envío existente en el API

coupon_valuenumber(float)

Cantidad a descontar relacionada con el cupón

coupon_namestring

Nombre del cupón incluido en la transacción

couponstring(uuid)

Identificador de cupón existente en el API

authorizeboolean

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

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",
  "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",
  "products": [
    { … }
  ],
  "tax_value": 0.1,
  "tax_name": "string",
  "tax": "2b46be7d-65ac-4a23-a5dd-524b80fe8e49",
  "shipping_value": 0.1,
  "shipping_name": "string",
  "shipping": "c7dce487-3172-461e-ada9-1450023e890a",
  "coupon_value": 0.1,
  "coupon_name": "string",
  "coupon": "925d4178-dd55-49ae-85e6-303d843dd1a2",
  "authorize": true,
  "source": [
    { … }
  ],
  "destination": [
    { … }
  ]
}

Obtener Transacción

Solicitud

Devuelve la transacción solicitada.

Seguridad
AppKeys
Ruta
transaction-idstring(uuid)requerido

Identificador de la transacción que se desea solicitar

curl -i -X GET \
  'https://api.zrupay.com/v1/transaction/{transaction-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)

productsArray of objects(item-product.v1)non-emptyrequerido

Lista de elementos de producto

products[].​amountnumber>= 1requerido

Cantidad del producto

products[].​product_idstring(uuid)

Identificador del producto existente en el API (requerido si no se envía el parámetro product)

products[].​productobject(product-create.v1)

Representa el modelo de datos para crear un producto.

tax_valuenumber(float)

Cantidad a pagar relacionada con el impuesto

tax_namestring

Nombre del impuesto incluido en la transacción

taxstring(uuid)

Identificador de impuesto existente en el API

shipping_valuenumber(float)

Cantidad a pagar relacionada con el envío

shipping_namestring

Nombre del envío incluido en la transacción

shippingstring(uuid)

Identificador de envío existente en el API

coupon_valuenumber(float)

Cantidad a descontar relacionada con el cupón

coupon_namestring

Nombre del cupón incluido en la transacción

couponstring(uuid)

Identificador de cupón existente en el API

authorizeboolean

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

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",
  "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",
  "products": [
    { … }
  ],
  "tax_value": 0.1,
  "tax_name": "string",
  "tax": "2b46be7d-65ac-4a23-a5dd-524b80fe8e49",
  "shipping_value": 0.1,
  "shipping_name": "string",
  "shipping": "c7dce487-3172-461e-ada9-1450023e890a",
  "coupon_value": 0.1,
  "coupon_name": "string",
  "coupon": "925d4178-dd55-49ae-85e6-303d843dd1a2",
  "authorize": true,
  "source": [
    { … }
  ],
  "destination": [
    { … }
  ]
}

Subscription

Operaciones

Authorization

Operaciones

Sale

Operaciones

Product

Operaciones

Plan

Operaciones

Tax

Operaciones

Shipping

Operaciones

Coupon

Operaciones

Client

Operaciones

Wallet

Operaciones

Transfer

Operaciones

Gateway

Operaciones

Currency

Currency

Operaciones