Listar Cuentas de Pago

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

api.v1.json

api.v1.yaml

Overview

Servers

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

Listar Cuentas de Pago

Request

Devuelve todos las cuentas de pago creadas en el entorno.

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

Responses

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(Cuenta de Pago)

Response

application/json

{
  "count": 0,
  "items_per_page": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Crear Cuenta de Pago

Request

Crea una cuenta de pago en el entorno.

Bodyapplication/json

wallet_idstring

Identificador externo

namestringrequired

Nombre

client_idstringrequired

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequired

Moneda en formato ISO

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

Responses

Bodyapplication/json

idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

wallet_idstring

Identificador externo

namestringrequired

Nombre

client_idstringrequired

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequired

Moneda en formato ISO

enabledboolean

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

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "wallet_id": "string",
  "name": "string",
  "client_id": "string",
  "currency": "str",
  "enabled": true
}

Obtener Cuenta de Pago

Request

Devuelve la cuenta de pago solicitada.

Path

wallet-idstring(uuid)required

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'

Responses

Bodyapplication/json

idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

wallet_idstring

Identificador externo

namestringrequired

Nombre

client_idstringrequired

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequired

Moneda en formato ISO

enabledboolean

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

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "wallet_id": "string",
  "name": "string",
  "client_id": "string",
  "currency": "str",
  "enabled": true
}

Editar Cuenta de Pago

Request

Edita la cuenta de pago solicitada.

Path

wallet-idstring(uuid)required

Identificador de la cuenta de pago que se desea solicitar

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

Responses

Bodyapplication/json

idstring(uuid)

Identificador único

enabled_by_complianceboolean

Si esta habilitado o no por compliance

wallet_idstring

Identificador externo

namestringrequired

Nombre

client_idstringrequired

Cliente a la que pertenece la cuenta de pago

currencystring= 3 charactersrequired

Moneda en formato ISO

enabledboolean

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

Response

application/json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "enabled_by_compliance": true,
  "wallet_id": "string",
  "name": "string",
  "client_id": "string",
  "currency": "str",
  "enabled": true
}

Listar Movimientos de la Cuenta de Pago

Request

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

Path

wallet-idstring(uuid)required

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'

Responses

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(Movimiento)

Response

application/json

{
  "count": 0,
  "items_per_page": 0,
  "next": "string",
  "previous": "string",
  "results": [
    { … }
  ]
}

Obtener Movimiento de la Cuenta de Pago

Request

Devuelve el movimiento solicitado de la cuenta de pago.

Path

wallet-idstring(uuid)required

Identificador de la cuenta de pago que se desea solicitar

entry-idstring(uuid)required

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'

Responses

Bodyapplication/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

Response

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

Operations

Gateway

Operations

Currency

Operations

API Reference (1.0)

Transaction

Subscription

Authorization

Sale

Product

Plan

Tax

Shipping

Coupon

Client

Wallet

Listar Cuentas de Pago

Request

Responses

¿Te ha sido útil?

Crear Cuenta de Pago

Request

Responses

¿Te ha sido útil?

Obtener Cuenta de Pago

Request

Responses

¿Te ha sido útil?

Editar Cuenta de Pago

Request

Responses

¿Te ha sido útil?

Listar Movimientos de la Cuenta de Pago

Request

Responses

¿Te ha sido útil?

Obtener Movimiento de la Cuenta de Pago

Request

Responses

¿Te ha sido útil?

Transfer

Gateway

Currency