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

Transfer

Operaciones

Listar Transferencias

Solicitud

Devuelve todas las transferencias creadas en el entorno.

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

Crear Transferencia

Solicitud

Crea una transferencia en el entorno.

Seguridad
AppKeys
Cuerpoapplication/json
transfer_idstring

Identificador externo

wallet_idstring(uuid)requerido

Identificador de la Cuenta de Pago

amountnumber(float)requerido

Cantidad a transferir

conceptstringrequerido

Concepto

to_wallet_idstring(uuid)

Identificador de la Cuenta de Pago a la que se transfiere

iban_idstring(uuid)

Identificador de iban existente en el API

iban_valuestring

IBAN externo

iban_ownerstring

Nombre del titular del IBAN externo

extrastring

Valores extra en formato JSON

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/transfer/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "wallet_id": "<WALLET_ID>",
    "amount": 1500.75,
    "concept": "TRANSFER_CONCEPT",
    "to_wallet_id": "<TO_WALLET_ID>",
    "iban_id": "<IBAN_ID>"
  }'

Respuestas

Created

Cuerpoapplication/json
idstring(uuid)

Identificador único

statusstring

Estado de la transferencia (N - Pendiente, D - Completada, F - Fallada)

Enumeración"P""D""F"
transfer_idstring

Identificador externo

wallet_idstring(uuid)requerido

Identificador de la Cuenta de Pago

amountnumber(float)requerido

Cantidad a transferir

conceptstringrequerido

Concepto

to_wallet_idstring(uuid)

Identificador de la Cuenta de Pago a la que se transfiere

iban_idstring(uuid)

Identificador de iban existente en el API

iban_valuestring

IBAN externo

iban_ownerstring

Nombre del titular del IBAN externo

extrastring

Valores extra en formato JSON

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",
  "status": "P",
  "transfer_id": "string",
  "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
  "amount": 0.1,
  "concept": "string",
  "to_wallet_id": "e76cfb2b-c24c-4bca-bf9b-3c5fd380ffd0",
  "iban_id": "3d0970c2-1841-4dbc-a01d-e8c0354ffbbf",
  "iban_value": "string",
  "iban_owner": "string",
  "extra": "string",
  "notify_url": "http://example.com"
}

Obtener Transferencia

Solicitud

Devuelve la transferencia solicitada.

Seguridad
AppKeys
Ruta
transfer-idstring(uuid)requerido

Identificador de la transferencia que se desea solicitar

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

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

statusstring

Estado de la transferencia (N - Pendiente, D - Completada, F - Fallada)

Enumeración"P""D""F"
transfer_idstring

Identificador externo

wallet_idstring(uuid)requerido

Identificador de la Cuenta de Pago

amountnumber(float)requerido

Cantidad a transferir

conceptstringrequerido

Concepto

to_wallet_idstring(uuid)

Identificador de la Cuenta de Pago a la que se transfiere

iban_idstring(uuid)

Identificador de iban existente en el API

iban_valuestring

IBAN externo

iban_ownerstring

Nombre del titular del IBAN externo

extrastring

Valores extra en formato JSON

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",
  "status": "P",
  "transfer_id": "string",
  "wallet_id": "d9a8fbfc-848f-43a2-9168-911ed3a04a48",
  "amount": 0.1,
  "concept": "string",
  "to_wallet_id": "e76cfb2b-c24c-4bca-bf9b-3c5fd380ffd0",
  "iban_id": "3d0970c2-1841-4dbc-a01d-e8c0354ffbbf",
  "iban_value": "string",
  "iban_owner": "string",
  "extra": "string",
  "notify_url": "http://example.com"
}

Gateway

Operaciones

Currency

Currency

Operaciones