Skip to content

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
index.json
index.yaml
Overview
Languages
Servers
v1

https://api.zrupay.com/v1/

Transaction

Operations

Subscription

Operations

Authorization

Operations

Sale

Operations

Product

Operations

Plan

Operations

Tax

Operations

Shipping

Operations

Coupon

Operations

Client

Operations

Listar Clientes

Request

Devuelve todos los clientes creados en el entorno.

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

Crear Cliente

Request

Crea un cliente en el entorno.

Security
AppKeys
Bodyapplication/json
namestringrequired

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enum"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enum"national""foreign""passport"
id_countrystring<= 2 charactersrequired

País

id_numberstringrequired

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

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

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

namestringrequired

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enum"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enum"national""foreign""passport"
id_countrystring<= 2 charactersrequired

País

id_numberstringrequired

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

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)

Response
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",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "province": "string",
  "country": "st",
  "enabled": true
}

Obtener Cliente

Request

Devuelve el cliente solicitado.

Security
AppKeys
Path
client-idstring(uuid)required

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'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

namestringrequired

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enum"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enum"national""foreign""passport"
id_countrystring<= 2 charactersrequired

País

id_numberstringrequired

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

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)

Response
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",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "province": "string",
  "country": "st",
  "enabled": true
}

Editar Cliente

Request

Edita el cliente solicitado.

Security
AppKeys
Path
client-idstring(uuid)required

Identificador del cliente que se desea solicitar

Bodyapplication/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"
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

namestringrequired

Nombre

client_idstring

Identificador externo

client_typestring(float)

Tipo de cliente (por defecto: individual)

Enum"individual""company"
id_typestring

Tipo de identificación (por defecto: national)

Enum"national""foreign""passport"
id_countrystring<= 2 charactersrequired

País

id_numberstringrequired

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

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)

Response
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",
  "street": "string",
  "postal_code": "string",
  "city": "string",
  "province": "string",
  "country": "st",
  "enabled": true
}

Listar IBANs del Cliente

Request

Devuelve todos los IBANs del Cliente creados en el entorno.

Security
AppKeys
Path
client-idstring(uuid)required

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'

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(IBAN)
Response
application/json
{
  "count": 0,
  "items_per_page": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Crear IBAN del Cliente

Request

Crea un IBAN del Cliente en el entorno.

Security
AppKeys
Path
client-idstring(uuid)required

Identificador del cliente que se desea solicitar

Bodyapplication/json
iban_idstring

Identificador externo

ibanstringrequired

IBAN

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

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

iban_idstring

Identificador externo

ibanstringrequired

IBAN

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iban_id": "string",
  "iban": "string"
}

Obtener IBAN del Cliente

Request

Devuelve el IBAN solicitado del Cliente.

Security
AppKeys
Path
client-idstring(uuid)required

Identificador del cliente que se desea solicitar

iban-idstring(uuid)required

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'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

iban_idstring

Identificador externo

ibanstringrequired

IBAN

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iban_id": "string",
  "iban": "string"
}

Editar IBAN del Cliente

Request

Editar el IBAN solicitado del Cliente.

Security
AppKeys
Path
client-idstring(uuid)required

Identificador del cliente que se desea solicitar

iban-idstring(uuid)required

Identificador del IBAN que se desea solicitar

Bodyapplication/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"
  }'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

iban_idstring

Identificador externo

ibanstringrequired

IBAN

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "iban_id": "string",
  "iban": "string"
}

Listar Documentos del Cliente

Request

Devuelve todos los Documentos del Cliente creados en el entorno.

Security
AppKeys
Path
client-idstring(uuid)required

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'

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(Documento)
Response
application/json
{
  "count": 0,
  "items_per_page": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Crear Documento del Cliente

Request

Crea un Documento del Cliente en el entorno.

Security
AppKeys
Path
client-idstring(uuid)required

Identificador del cliente que se desea solicitar

Bodyapplication/json
filefilerequired

Documento a subir

typestringrequired

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

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

statusstring

Estado del documento

filefilerequired

Documento a subir

typestringrequired

Tipo de documento

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

Obtener Documento del Cliente

Request

Devuelve el Documento solicitado del Cliente.

Security
AppKeys
Path
client-idstring(uuid)required

Identificador del cliente que se desea solicitar

document-idstring(uuid)required

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'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

statusstring

Estado del documento

filefilerequired

Documento a subir

typestringrequired

Tipo de documento

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

Wallet

Operations

Transfer

Operations

Gateway

Operations

Currency

Currency

Operations