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

Listar Clientes

Solicitud

Devuelve todos los clientes creados en el entorno.

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

Crear Cliente

Solicitud

Crea un cliente en el entorno.

Seguridad
AppKeys
Cuerpoapplication/json
namestringrequerido

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enumeración"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enumeración"national""foreign""passport"
id_countrystring<= 2 charactersrequerido

País

id_numberstringrequerido

Número de identificación

id_expiration_datestring(date)YYYY-MM-DD

Fecha de expiración de la identificación

emailstring(email)

Correo electrónico

phonestring

Teléfono

webstring(uri)

Web

incorporation_datestring(date)YYYY-MM-DD

Fecha de incorporación de la empresa

birth_datestring(date)YYYY-MM-DD

Fecha de nacimiento del individuo

birth_countrystring<= 2 characters

País de nacimiento del individuo

nationalitystring<= 2 characters

Nacionalidad del individuo

streetstring

Calle y número

postal_codestring

Código postal

citystring

Ciudad

provincestring

Provincia

countrystring<= 2 characters

País

notify_urlstring(uri)

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

enabledboolean

Si esta habilitado o no (por defecto: False)

curl -i -X POST \
  https://api.zrupay.com/v1/client/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "CLIENT_NAME",
    "id_country": "ES",
    "id_number": "24968842L"
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

namestringrequerido

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enumeración"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enumeración"national""foreign""passport"
id_countrystring<= 2 charactersrequerido

País

id_numberstringrequerido

Número de identificación

id_expiration_datestring(date)YYYY-MM-DD

Fecha de expiración de la identificación

emailstring(email)

Correo electrónico

phonestring

Teléfono

webstring(uri)

Web

incorporation_datestring(date)YYYY-MM-DD

Fecha de incorporación de la empresa

birth_datestring(date)YYYY-MM-DD

Fecha de nacimiento del individuo

birth_countrystring<= 2 characters

País de nacimiento del individuo

nationalitystring<= 2 characters

Nacionalidad del individuo

streetstring

Calle y número

postal_codestring

Código postal

citystring

Ciudad

provincestring

Provincia

countrystring<= 2 characters

País

notify_urlstring(uri)

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

enabledboolean

Si esta habilitado o no (por defecto: False)

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "name": "string",
  "client_id": "string",
  "client_type": "individual",
  "id_type": "national",
  "id_country": "st",
  "id_number": "string",
  "id_expiration_date": "2019-08-24",
  "email": "user@example.com",
  "phone": "string",
  "web": "http://example.com",
  "incorporation_date": "2019-08-24",
  "birth_date": "2019-08-24",
  "birth_country": "st",
  "nationality": "st",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "province": "string",
  "country": "st",
  "notify_url": "http://example.com",
  "enabled": true
}

Obtener Cliente

Solicitud

Devuelve el cliente solicitado.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

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

namestringrequerido

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enumeración"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enumeración"national""foreign""passport"
id_countrystring<= 2 charactersrequerido

País

id_numberstringrequerido

Número de identificación

id_expiration_datestring(date)YYYY-MM-DD

Fecha de expiración de la identificación

emailstring(email)

Correo electrónico

phonestring

Teléfono

webstring(uri)

Web

incorporation_datestring(date)YYYY-MM-DD

Fecha de incorporación de la empresa

birth_datestring(date)YYYY-MM-DD

Fecha de nacimiento del individuo

birth_countrystring<= 2 characters

País de nacimiento del individuo

nationalitystring<= 2 characters

Nacionalidad del individuo

streetstring

Calle y número

postal_codestring

Código postal

citystring

Ciudad

provincestring

Provincia

countrystring<= 2 characters

País

notify_urlstring(uri)

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

enabledboolean

Si esta habilitado o no (por defecto: False)

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "name": "string",
  "client_id": "string",
  "client_type": "individual",
  "id_type": "national",
  "id_country": "st",
  "id_number": "string",
  "id_expiration_date": "2019-08-24",
  "email": "user@example.com",
  "phone": "string",
  "web": "http://example.com",
  "incorporation_date": "2019-08-24",
  "birth_date": "2019-08-24",
  "birth_country": "st",
  "nationality": "st",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "province": "string",
  "country": "st",
  "notify_url": "http://example.com",
  "enabled": true
}

Editar Cliente

Solicitud

Edita el cliente solicitado.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

Cuerpoapplication/json
namestring

Nombre

client_idstring

Identificador externo

emailstring(email)

Correo electrónico

phonestring

Teléfono

webstring(uri)

Web

streetstring

Calle y número

postal_codestring

Código postal

citystring

Ciudad

provincestring

Provincia

countrystring<= 2 characters

País

enabledboolean

Si esta habilitado o no (por defecto: False)

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

namestringrequerido

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enumeración"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enumeración"national""foreign""passport"
id_countrystring<= 2 charactersrequerido

País

id_numberstringrequerido

Número de identificación

id_expiration_datestring(date)YYYY-MM-DD

Fecha de expiración de la identificación

emailstring(email)

Correo electrónico

phonestring

Teléfono

webstring(uri)

Web

incorporation_datestring(date)YYYY-MM-DD

Fecha de incorporación de la empresa

birth_datestring(date)YYYY-MM-DD

Fecha de nacimiento del individuo

birth_countrystring<= 2 characters

País de nacimiento del individuo

nationalitystring<= 2 characters

Nacionalidad del individuo

streetstring

Calle y número

postal_codestring

Código postal

citystring

Ciudad

provincestring

Provincia

countrystring<= 2 characters

País

notify_urlstring(uri)

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

enabledboolean

Si esta habilitado o no (por defecto: False)

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "name": "string",
  "client_id": "string",
  "client_type": "individual",
  "id_type": "national",
  "id_country": "st",
  "id_number": "string",
  "id_expiration_date": "2019-08-24",
  "email": "user@example.com",
  "phone": "string",
  "web": "http://example.com",
  "incorporation_date": "2019-08-24",
  "birth_date": "2019-08-24",
  "birth_country": "st",
  "nationality": "st",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "province": "string",
  "country": "st",
  "notify_url": "http://example.com",
  "enabled": true
}

Listar IBANs del Cliente

Solicitud

Devuelve todos los IBANs del Cliente creados en el entorno.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

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

Crear IBAN del Cliente

Solicitud

Crea un IBAN del Cliente en el entorno.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

Cuerpoapplication/json
iban_idstring

Identificador externo

ibanstringrequerido

IBAN

notify_urlstring(uri)

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

curl -i -X POST \
  'https://api.zrupay.com/v1/client/{client-id}/iban/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "iban_id": "MERCHANT_IBAN_ID",
    "iban": "ES91 2100 0418 4502 0005 1332"
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

iban_idstring

Identificador externo

ibanstringrequerido

IBAN

notify_urlstring(uri)

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

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iban_id": "string",
  "iban": "string",
  "notify_url": "http://example.com"
}

Obtener IBAN del Cliente

Solicitud

Devuelve el IBAN solicitado del Cliente.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

iban-idstring(uuid)requerido

Identificador del IBAN que se desea solicitar

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

iban_idstring

Identificador externo

ibanstringrequerido

IBAN

notify_urlstring(uri)

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

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iban_id": "string",
  "iban": "string",
  "notify_url": "http://example.com"
}

Editar IBAN del Cliente

Solicitud

Editar el IBAN solicitado del Cliente.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

iban-idstring(uuid)requerido

Identificador del IBAN que se desea solicitar

Cuerpoapplication/json
iban_idstring

Identificador externo

curl -i -X PATCH \
  'https://api.zrupay.com/v1/client/{client-id}/iban/{iban-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "iban_id": "2432876"
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

iban_idstring

Identificador externo

ibanstringrequerido

IBAN

notify_urlstring(uri)

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

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iban_id": "string",
  "iban": "string",
  "notify_url": "http://example.com"
}

Listar Documentos del Cliente

Solicitud

Devuelve todos los Documentos del Cliente creados en el entorno.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

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

Crear Documento del Cliente

Solicitud

Crea un Documento del Cliente en el entorno.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

Cuerpoapplication/json
filefilerequerido

Documento a subir

typestringrequerido

Tipo de documento

curl -i -X POST \
  'https://api.zrupay.com/v1/client/{client-id}/document/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "file": "<file>",
    "type": "identification"
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

statusstring

Estado del documento

filefilerequerido

Documento a subir

typestringrequerido

Tipo de documento

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "string",
  "file": null,
  "type": "string"
}

Obtener Documento del Cliente

Solicitud

Devuelve el Documento solicitado del Cliente.

Seguridad
AppKeys
Ruta
client-idstring(uuid)requerido

Identificador del cliente que se desea solicitar

document-idstring(uuid)requerido

Identificador del Documento que se desea solicitar

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

statusstring

Estado del documento

filefilerequerido

Documento a subir

typestringrequerido

Tipo de documento

Respuesta
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "string",
  "file": null,
  "type": "string"
}

Wallet

Operaciones

Transfer

Operaciones

Gateway

Operaciones

Currency

Currency

Operaciones