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

Wallet

Operations

Transfer

Operations

Listar Transferencias

Request

Devuelve todas las transferencias creadas en el entorno.

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

Crear Transferencia

Request

Crea una transferencia en el entorno.

Security
AppKeys
Bodyapplication/json
transfer_idstring

Identificador externo

wallet_idstring(uuid)required

Identificador de la Cuenta de Pago

amountnumber(float)required

Cantidad a transferir

conceptstringrequired

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

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

Responses

Created

Bodyapplication/json
idstring(uuid)

Identificador único

statusstring

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

Enum"P""D""F"
transfer_idstring

Identificador externo

wallet_idstring(uuid)required

Identificador de la Cuenta de Pago

amountnumber(float)required

Cantidad a transferir

conceptstringrequired

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

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

Obtener Transferencia

Request

Devuelve la transferencia solicitada.

Security
AppKeys
Path
transfer-idstring(uuid)required

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'

Responses

OK

Bodyapplication/json
idstring(uuid)

Identificador único

statusstring

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

Enum"P""D""F"
transfer_idstring

Identificador externo

wallet_idstring(uuid)required

Identificador de la Cuenta de Pago

amountnumber(float)required

Cantidad a transferir

conceptstringrequired

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

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

Gateway

Operations

Currency

Currency

Operations