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

Product

Operaciones

Plan

Operaciones

Tax

Operaciones

Shipping

Operaciones

Coupon

Operaciones

Client

Operaciones

Wallet

Operaciones

Listar Cuentas de Pago

Solicitud

Devuelve todos las cuentas de pago creadas en el entorno.

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

Crear Cuenta de Pago

Solicitud

Crea una cuenta de pago en el entorno.

Seguridad
AppKeys
Cuerpoapplication/json
wallet_idstring

Identificador externo

namestringrequerido

Nombre

client_idstringrequerido

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequerido

Moneda en formato ISO

notify_urlstring(uri)

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

enabledboolean

Si está habilitado o no (por defecto: False)

curl -i -X POST \
  https://api.zrupay.com/v1/wallet/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "wallet_id": "MERCHANT_WALLET_ID",
    "name": "WALLET_NAME",
    "client_id": "<CLIENT_ID>",
    "currency": "EUR",
    "enabled": true
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

wallet_idstring

Identificador externo

namestringrequerido

Nombre

client_idstringrequerido

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequerido

Moneda en formato ISO

notify_urlstring(uri)

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

enabledboolean

Si está habilitado o no (por defecto: False)

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "wallet_id": "string",
  "name": "string",
  "client_id": "string",
  "currency": "str",
  "notify_url": "http://example.com",
  "enabled": true
}

Obtener Cuenta de Pago

Solicitud

Devuelve la cuenta de pago solicitada.

Seguridad
AppKeys
Ruta
wallet-idstring(uuid)requerido

Identificador de la cuenta de pago que se desea solicitar

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

wallet_idstring

Identificador externo

namestringrequerido

Nombre

client_idstringrequerido

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequerido

Moneda en formato ISO

notify_urlstring(uri)

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

enabledboolean

Si está habilitado o no (por defecto: False)

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "wallet_id": "string",
  "name": "string",
  "client_id": "string",
  "currency": "str",
  "notify_url": "http://example.com",
  "enabled": true
}

Editar Cuenta de Pago

Solicitud

Edita la cuenta de pago solicitada.

Seguridad
AppKeys
Ruta
wallet-idstring(uuid)requerido

Identificador de la cuenta de pago que se desea solicitar

Cuerpoapplication/json
wallet_idstring

Identificador externo

namestring

Nombre

enabledboolean

Si está habilitado o no (por defecto: False)

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

wallet_idstring

Identificador externo

namestringrequerido

Nombre

client_idstringrequerido

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequerido

Moneda en formato ISO

notify_urlstring(uri)

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

enabledboolean

Si está habilitado o no (por defecto: False)

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "wallet_id": "string",
  "name": "string",
  "client_id": "string",
  "currency": "str",
  "notify_url": "http://example.com",
  "enabled": true
}

Listar Movimientos de la Cuenta de Pago

Solicitud

Devuelve todos los movimientos de la cuentas de pago existentes en el entorno.

Seguridad
AppKeys
Ruta
wallet-idstring(uuid)requerido

Identificador de la cuenta de pago que se desea solicitar

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

Obtener Movimiento de la Cuenta de Pago

Solicitud

Devuelve el movimiento solicitado de la cuenta de pago.

Seguridad
AppKeys
Ruta
wallet-idstring(uuid)requerido

Identificador de la cuenta de pago que se desea solicitar

entry-idstring(uuid)requerido

Identificador del movimiento que se desea solicitar

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

walletstring(uuid)

Identificador de la cuenta de pago a la que pertenece

amountnumber(float)

Cantidad

balancenumber(float)

Balance de la cuenta de pago después del movimiento

conceptstring

Concepto del movimiento

currencystring= 3 characters

Moneda en formato ISO

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

Fecha del movimiento

with_walletstring or null(uuid)

Cuenta de pago con la que tiene relación el movimiento

with_salestring or null(uuid)

Pago con el que tiene relación el movimiento

with_externalstring or null

Método externo relacionada con el movimiento

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "wallet": "7e04ca6f-1090-4fc4-bba5-96db96e0dd2b",
  "amount": 0.1,
  "balance": 0.1,
  "concept": "string",
  "currency": "str",
  "date": "2019-08-24T14:15:22Z",
  "with_wallet": "4e35e68a-8d5a-4f9d-81cb-a3567c8f6a48",
  "with_sale": "d29bd245-1299-4b2c-96a8-625e0f49353f",
  "with_external": "string"
}

Transfer

Operaciones

Gateway

Operaciones

Currency

Currency

Operaciones